diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index 3003b9c071..471e2b1bc6 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -1205,6 +1205,11 @@ "name" ], "parameters": { + "appendScopedAccessSettings": { + "description": "Optional. This field will be used to control whether or not scoped access settings are appended to the existing list of scoped access settings. If true, the scoped access settings in the request will be appended to the existing list of scoped access settings. If false, the scoped access settings in the request replace the existing list of scoped access settings.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: \"organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N\"", "location": "path", @@ -1213,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`. 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`, `reauth_settings`, `scoped_access_settings`. update_mask { paths: \"access_levels\" }", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1290,7 +1295,7 @@ } } }, - "revision": "20240811", + "revision": "20240923", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1357,6 +1362,35 @@ }, "type": "object" }, + "AccessScope": { + "description": "Access scope represents the client scope, etc. to which the settings will be applied to.", + "id": "AccessScope", + "properties": { + "clientScope": { + "$ref": "ClientScope", + "description": "Optional. Client scope for this access scope." + } + }, + "type": "object" + }, + "AccessSettings": { + "description": "Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set.", + "id": "AccessSettings", + "properties": { + "accessLevels": { + "description": "Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: \"accessPolicies/9522/accessLevels/device_trusted\"", + "items": { + "type": "string" + }, + "type": "array" + }, + "reauthSettings": { + "$ref": "ReauthSettings", + "description": "Optional. Reauth settings applied to user access on a given AccessScope." + } + }, + "type": "object" + }, "ApiOperation": { "description": "Identification for an API Operation.", "id": "ApiOperation", @@ -1550,6 +1584,17 @@ "properties": {}, "type": "object" }, + "ClientScope": { + "description": "Client scope represents the application, etc. subject to this binding's restrictions.", + "id": "ClientScope", + "properties": { + "restrictedClientApplication": { + "$ref": "Application", + "description": "Optional. The application that is subject to this binding's scope." + } + }, + "type": "object" + }, "CommitServicePerimetersRequest": { "description": "A request to commit dry-run specs in all Service Perimeters belonging to an Access Policy.", "id": "CommitServicePerimetersRequest", @@ -1860,12 +1905,23 @@ "description": "Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: \"organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N\"", "type": "string" }, + "reauthSettings": { + "$ref": "ReauthSettings", + "description": "Optional. GCSL policy for the group key." + }, "restrictedClientApplications": { "description": "Optional. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications.", "items": { "$ref": "Application" }, "type": "array" + }, + "scopedAccessSettings": { + "description": "Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set.", + "items": { + "$ref": "ScopedAccessSettings" + }, + "type": "array" } }, "type": "object" @@ -2231,6 +2287,47 @@ }, "type": "object" }, + "ReauthSettings": { + "description": "Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings.", + "id": "ReauthSettings", + "properties": { + "maxInactivity": { + "description": "Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps.", + "format": "google-duration", + "type": "string" + }, + "reauthMethod": { + "description": "Optional. Reauth method when users GCP session is up.", + "enum": [ + "REAUTH_METHOD_UNSPECIFIED", + "LOGIN", + "SECURITY_KEY", + "PASSWORD" + ], + "enumDescriptions": [ + "If method undefined in API, we will use LOGIN by default.", + "The user will prompted to perform regular login. Users who are enrolled for two-step verification and haven't chosen to \"Remember this computer\" will be prompted for their second factor.", + "The user will be prompted to autheticate using their security key. If no security key has been configured, then we will fallback to LOGIN.", + "The user will be prompted for their password." + ], + "type": "string" + }, + "sessionLength": { + "description": "Optional. The session length. Setting this field to zero is equal to disabling. Reauth. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param.", + "format": "google-duration", + "type": "string" + }, + "sessionLengthEnabled": { + "description": "Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite.", + "type": "boolean" + }, + "useOidcMaxAge": { + "description": "Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param.", + "type": "boolean" + } + }, + "type": "object" + }, "ReplaceAccessLevelsRequest": { "description": "A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.", "id": "ReplaceAccessLevelsRequest", @@ -2295,6 +2392,25 @@ }, "type": "object" }, + "ScopedAccessSettings": { + "description": "A relationship between access settings and its scope.", + "id": "ScopedAccessSettings", + "properties": { + "activeSettings": { + "$ref": "AccessSettings", + "description": "Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set." + }, + "dryRunSettings": { + "$ref": "AccessSettings", + "description": "Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set." + }, + "scope": { + "$ref": "AccessScope", + "description": "Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty." + } + }, + "type": "object" + }, "ServicePerimeter": { "description": "`ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.", "id": "ServicePerimeter", diff --git a/discovery/adexchangebuyer2-v2beta1.json b/discovery/adexchangebuyer2-v2beta1.json index bad603521b..01bc638fd2 100644 --- a/discovery/adexchangebuyer2-v2beta1.json +++ b/discovery/adexchangebuyer2-v2beta1.json @@ -3115,7 +3115,7 @@ } } }, - "revision": "20231213", + "revision": "20241002", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { @@ -6570,22 +6570,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 63989910ca..ef6688c02c 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -15,10 +15,10 @@ "description": "View customer related information" }, "https://www.googleapis.com/auth/admin.directory.device.chromeos": { - "description": "View and manage your Chrome OS devices' metadata" + "description": "View and manage your ChromeOS devices' metadata" }, "https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly": { - "description": "View your Chrome OS devices' metadata" + "description": "View your ChromeOS devices' metadata" }, "https://www.googleapis.com/auth/admin.directory.device.mobile": { "description": "View and manage your mobile devices' metadata" @@ -1677,7 +1677,7 @@ "type": "string" }, "userKey": { - "description": "Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.", + "description": "Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter.", "location": "query", "type": "string" } @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240709", + "revision": "20240924", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6245,7 +6245,7 @@ "type": "string" }, "payload": { - "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The delay has to be in the range [0, 300]. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).", + "description": "The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { \"volume\": 50 }. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { \"ackedUserPresence\": true, \"crdSessionType\": string }. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. * `REBOOT`: Payload is a stringified JSON object in the form: { \"user_session_delay_seconds\": 300 }. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {\"supportPacketDetails\":{ \"issueCaseId\": optional_support_case_id_string, \"issueDescription\": optional_issue_description_string, \"requestedDataCollectors\": []}} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log).", "type": "string" } }, diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 04968c6060..61aceac719 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -2246,7 +2246,7 @@ "annotations": { "methods": { "list": { - "description": "Lists Annotations belongs to a dataitem", + "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.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -4271,7 +4271,7 @@ ], "parameters": { "featureGroupId": { - "description": "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 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.", + "description": "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.", "location": "query", "type": "string" }, @@ -4956,6 +4956,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}/featureOnlineStores/{featureOnlineStoresId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists FeatureOnlineStores in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", @@ -5035,6 +5066,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}/featureOnlineStores/{featureOnlineStoresId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$", + "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}/featureOnlineStores/{featureOnlineStoresId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.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/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -5156,6 +5246,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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:getIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists FeatureViews in a given FeatureOnlineStore.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", @@ -5264,6 +5385,34 @@ "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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:setIamPolicy", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "sync": { "description": "Triggers on-demand sync for the FeatureView.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", @@ -5291,6 +5440,37 @@ "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}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:testIamPermissions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.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/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -6410,7 +6590,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "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}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -17296,6 +17476,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "rebaseTunedModel": { + "description": "Rebase a TunedModel.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1RebaseTunedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -17326,6 +17534,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", @@ -17580,7 +17813,7 @@ } } }, - "revision": "20240816", + "revision": "20240925", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -17719,8 +17952,16 @@ "type": "object" }, "CloudAiLargeModelsVisionRaiInfo": { + "description": "Next ID: 6", "id": "CloudAiLargeModelsVisionRaiInfo", "properties": { + "blockedEntities": { + "description": "List of blocked entities from the blocklist if it is detected.", + "items": { + "type": "string" + }, + "type": "array" + }, "detectedLabels": { "description": "The list of detected labels for different rai categories.", "items": { @@ -18366,11 +18607,11 @@ "type": "object" }, "GoogleCloudAiplatformV1BatchCreateFeaturesRequest": { - "description": "Request message for FeaturestoreService.BatchCreateFeatures.", + "description": "Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.", "id": "GoogleCloudAiplatformV1BatchCreateFeaturesRequest", "properties": { "requests": { - "description": "Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.", + "description": "Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.", "items": { "$ref": "GoogleCloudAiplatformV1CreateFeatureRequest" }, @@ -19224,6 +19465,11 @@ "readOnly": true, "type": "integer" }, + "logprobsResult": { + "$ref": "GoogleCloudAiplatformV1LogprobsResult", + "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "readOnly": true + }, "safetyRatings": { "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { @@ -19664,6 +19910,10 @@ }, "type": "array" }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfig", + "description": "Optional. Generation config that the model will use to generate the response." + }, "instances": { "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { @@ -19902,6 +20152,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest": { + "description": "Request message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest", + "properties": { + "notebookExecutionJob": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob", + "description": "Required. The NotebookExecutionJob to create." + }, + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -20863,6 +21132,13 @@ "description": "Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.", "readOnly": true }, + "pscAutomationConfigs": { + "description": "Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1PSCAutomationConfig" + }, + "type": "array" + }, "reservedIpRanges": { "description": "Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.", "items": { @@ -22872,6 +23148,10 @@ "$ref": "GoogleCloudAiplatformV1BigQuerySource", "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." }, + "dense": { + "description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores.", + "type": "boolean" + }, "entityIdColumns": { "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", "items": { @@ -22879,6 +23159,10 @@ }, "type": "array" }, + "staticDataSource": { + "description": "Optional. Set if the data source is not a time-series.", + "type": "boolean" + }, "timeSeries": { "$ref": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary." @@ -23292,6 +23576,10 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "vertexRagSource": { + "$ref": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", + "description": "Optional. The Vertex RAG Source that the FeatureView is linked to." } }, "type": "object" @@ -23525,6 +23813,22 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1FeatureViewVertexRagSource": { + "description": "A Vertex Rag source for features that need to be synced to Online Store.", + "id": "GoogleCloudAiplatformV1FeatureViewVertexRagSource", + "properties": { + "ragCorpusId": { + "description": "Optional. The RAG corpus id corresponding to this FeatureView.", + "format": "int64", + "type": "string" + }, + "uri": { + "description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED)", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Featurestore": { "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1Featurestore", @@ -24178,6 +24482,10 @@ "parameters": { "$ref": "GoogleCloudAiplatformV1Schema", "description": "Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1Schema", + "description": "Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function." } }, "type": "object" @@ -24195,7 +24503,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. The function response in JSON object format.", + "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", "type": "object" } }, @@ -24241,6 +24549,13 @@ "$ref": "GoogleCloudAiplatformV1GenerationConfig", "description": "Optional. Generation config." }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" + }, "safetySettings": { "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", "items": { @@ -24278,6 +24593,11 @@ "readOnly": true, "type": "array" }, + "modelVersion": { + "description": "Output only. The model version used to generate the response.", + "readOnly": true, + "type": "string" + }, "promptFeedback": { "$ref": "GoogleCloudAiplatformV1GenerateContentResponsePromptFeedback", "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", @@ -24344,6 +24664,7 @@ "type": "integer" }, "totalTokenCount": { + "description": "Total token count for prompt and response candidates.", "format": "int32", "type": "integer" } @@ -24364,6 +24685,11 @@ "format": "float", "type": "number" }, + "logprobs": { + "description": "Optional. Logit probabilities.", + "format": "int32", + "type": "integer" + }, "maxOutputTokens": { "description": "Optional. The maximum number of output tokens to generate per message.", "format": "int32", @@ -24374,6 +24700,10 @@ "format": "float", "type": "number" }, + "responseLogprobs": { + "description": "Optional. If true, export the logprobs results in response.", + "type": "boolean" + }, "responseMimeType": { "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" @@ -26402,6 +26732,62 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1LogprobsResult": { + "description": "Logprobs Result", + "id": "GoogleCloudAiplatformV1LogprobsResult", + "properties": { + "chosenCandidates": { + "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" + }, + "type": "array" + }, + "topCandidates": { + "description": "Length = total number of decoding steps.", + "items": { + "$ref": "GoogleCloudAiplatformV1LogprobsResultTopCandidates" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1LogprobsResultCandidate": { + "description": "Candidate for the logprobs token and score.", + "id": "GoogleCloudAiplatformV1LogprobsResultCandidate", + "properties": { + "logProbability": { + "description": "The candidate's log probability.", + "format": "float", + "type": "number" + }, + "token": { + "description": "The candidate’s token string value.", + "type": "string" + }, + "tokenId": { + "description": "The candidate’s token id value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1LogprobsResultTopCandidates": { + "description": "Candidates with top log probabilities at each decoding step.", + "id": "GoogleCloudAiplatformV1LogprobsResultTopCandidates", + "properties": { + "candidates": { + "description": "Sorted by log probability in descending order.", + "items": { + "$ref": "GoogleCloudAiplatformV1LogprobsResultCandidate" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1LookupStudyRequest": { "description": "Request message for VizierService.LookupStudy.", "id": "GoogleCloudAiplatformV1LookupStudyRequest", @@ -29274,6 +29660,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PSCAutomationConfig": { + "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", + "id": "GoogleCloudAiplatformV1PSCAutomationConfig", + "properties": { + "network": { + "description": "Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.", + "type": "string" + }, + "projectId": { + "description": "Required. Project id used to create forwarding rule.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PairwiseMetricInput": { "description": "Input for pairwise metric.", "id": "GoogleCloudAiplatformV1PairwiseMetricInput", @@ -31627,6 +32028,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RebaseTunedModelRequest": { + "description": "Request message for GenAiTuningService.RebaseTunedModel.", + "id": "GoogleCloudAiplatformV1RebaseTunedModelRequest", + "properties": { + "artifactDestination": { + "$ref": "GoogleCloudAiplatformV1GcsDestination", + "description": "Optional. The Google Cloud Storage location to write the artifacts." + }, + "deployToSameEndpoint": { + "description": "Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section.", + "type": "boolean" + }, + "tunedModelRef": { + "$ref": "GoogleCloudAiplatformV1TunedModelRef", + "description": "Required. TunedModel reference to retrieve the legacy model information." + }, + "tuningJob": { + "$ref": "GoogleCloudAiplatformV1TuningJob", + "description": "Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata": { "description": "Details of operations that perform reboot PersistentResource.", "id": "GoogleCloudAiplatformV1RebootPersistentResourceOperationMetadata", @@ -31986,14 +32410,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -32086,14 +32512,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "type": "string" }, @@ -32118,14 +32546,16 @@ "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", - "BLOCK_NONE" + "BLOCK_NONE", + "OFF" ], "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", - "Block none." + "Block none.", + "Turn off the safety filter." ], "type": "string" } @@ -32289,6 +32719,10 @@ "readOnly": true, "type": "boolean" }, + "createNotebookExecutionJobRequest": { + "$ref": "GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest", + "description": "Request for NotebookService.CreateNotebookExecutionJob." + }, "createPipelineJobRequest": { "$ref": "GoogleCloudAiplatformV1CreatePipelineJobRequest", "description": "Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})." @@ -32427,7 +32861,7 @@ "LOW_COST", "STANDARD", "SPOT", - "DWS_FLEX_START" + "FLEX_START" ], "enumDeprecated": [ false, @@ -32443,7 +32877,7 @@ "Deprecated. Low cost by making potential use of spot resources.", "Standard provisioning strategy uses regular on-demand resources.", "Spot provisioning strategy uses spot resources.", - "DWS Flex start strategy uses DWS to queue for resources." + "Flex Start strategy uses DWS to queue for resources." ], "type": "string" }, @@ -32456,9 +32890,16 @@ "type": "object" }, "GoogleCloudAiplatformV1Schema": { - "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). More fields may be added in the future as needed.", + "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": "GoogleCloudAiplatformV1Schema", "properties": { + "anyOf": { + "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", + "items": { + "$ref": "GoogleCloudAiplatformV1Schema" + }, + "type": "array" + }, "default": { "description": "Optional. Default value of the data.", "type": "any" @@ -32541,6 +32982,13 @@ "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", "type": "object" }, + "propertyOrdering": { + "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", + "items": { + "type": "string" + }, + "type": "array" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -34499,6 +34947,10 @@ "description": "Whether the prompt dataset has prompt variable.", "type": "boolean" }, + "logprobs": { + "description": "Whether or not the user has enabled logit probabilities in the model parameters.", + "type": "boolean" + }, "maxOutputTokens": { "description": "Value of the maximum number of tokens generated set when the dataset was saved.", "format": "int64", @@ -34512,6 +34964,15 @@ "description": "Type of the prompt dataset.", "type": "string" }, + "seedEnabled": { + "description": "Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled.", + "type": "boolean" + }, + "seedValue": { + "description": "The actual value of the seed.", + "format": "int64", + "type": "string" + }, "stopSequences": { "description": "Customized stop sequences.", "items": { @@ -37834,7 +38295,7 @@ "type": "object" }, "GoogleCloudAiplatformV1SupervisedTuningSpec": { - "description": "Tuning Spec for Supervised Tuning.", + "description": "Tuning Spec for Supervised Tuning for first party models.", "id": "GoogleCloudAiplatformV1SupervisedTuningSpec", "properties": { "hyperParameters": { @@ -37859,7 +38320,7 @@ "type": "object" }, "GoogleCloudAiplatformV1SyncFeatureViewResponse": { - "description": "Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1SyncFeatureViewResponse", "properties": { "featureViewSync": { @@ -38452,7 +38913,7 @@ "id": "GoogleCloudAiplatformV1Tool", "properties": { "functionDeclarations": { - "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.", + "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", "items": { "$ref": "GoogleCloudAiplatformV1FunctionDeclaration" }, @@ -39022,6 +39483,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1TunedModelRef": { + "description": "TunedModel Reference for legacy model migration.", + "id": "GoogleCloudAiplatformV1TunedModelRef", + "properties": { + "pipelineJob": { + "description": "Support migration from tuning job list page, from bison model to gemini model.", + "type": "string" + }, + "tunedModel": { + "description": "Support migration from model registry.", + "type": "string" + }, + "tuningJob": { + "description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1TuningDataStats": { "description": "The tuning data statistic values for TuningJob.", "id": "GoogleCloudAiplatformV1TuningDataStats", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index eb59aa7344..a60ec59680 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -894,6 +894,62 @@ "resources": { "locations": { "methods": { + "augmentPrompt": { + "description": "Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:augmentPrompt", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.augmentPrompt", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:augmentPrompt", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "corroborateContent": { + "description": "Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:corroborateContent", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.corroborateContent", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}:corroborateContent", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "evaluateInstances": { "description": "Evaluates instances based on a given metric.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}:evaluateInstances", @@ -2836,7 +2892,7 @@ "annotations": { "methods": { "list": { - "description": "Lists Annotations belongs to a dataitem", + "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.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dataItems/{dataItemsId}/annotations", "httpMethod": "GET", "id": "aiplatform.projects.locations.datasets.dataItems.annotations.list", @@ -5714,7 +5770,8 @@ "$ref": "GoogleCloudAiplatformV1beta1ListExtensionsResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "patch": { @@ -5946,7 +6003,7 @@ ], "parameters": { "featureGroupId": { - "description": "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 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.", + "description": "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.", "location": "query", "type": "string" }, @@ -8287,7 +8344,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "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}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -16493,6 +16550,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates a RagCorpus.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/ragCorpora/{ragCorporaId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.ragCorpora.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the RagCorpus.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/ragCorpora/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RagCorpus" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -20802,6 +20887,65 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "rebaseTunedModel": { + "description": "Rebase a TunedModel.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs:rebaseTunedModel", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.tuningJobs.rebaseTunedModel", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/tuningJobs:rebaseTunedModel", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/tuningJobs/{tuningJobsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.tuningJobs.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/tuningJobs/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } @@ -21058,7 +21202,7 @@ } } }, - "revision": "20240816", + "revision": "20240925", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -21197,8 +21341,16 @@ "type": "object" }, "CloudAiLargeModelsVisionRaiInfo": { + "description": "Next ID: 6", "id": "CloudAiLargeModelsVisionRaiInfo", "properties": { + "blockedEntities": { + "description": "List of blocked entities from the blocklist if it is detected.", + "items": { + "type": "string" + }, + "type": "array" + }, "detectedLabels": { "description": "The list of detected labels for different rai categories.", "items": { @@ -21614,6 +21766,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ApiAuth": { + "description": "The generic reusable api auth config.", + "id": "GoogleCloudAiplatformV1beta1ApiAuth", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", + "description": "The API secret." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { "description": "The API secret.", "id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", @@ -21702,6 +21865,30 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ArtifactTypeSchema": { + "description": "The definition of a artifact type in MLMD.", + "id": "GoogleCloudAiplatformV1beta1ArtifactTypeSchema", + "properties": { + "instanceSchema": { + "description": "Contains a raw YAML string, describing the format of the properties of the type.", + "type": "string" + }, + "schemaTitle": { + "description": "The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store.", + "type": "string" + }, + "schemaUri": { + "deprecated": true, + "description": "Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead.", + "type": "string" + }, + "schemaVersion": { + "description": "The schema version of the artifact. If the value is not set, it defaults to the latest version in the system.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.AssignNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1AssignNotebookRuntimeOperationMetadata", @@ -21785,6 +21972,64 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1AugmentPromptRequest": { + "description": "Request message for AugmentPrompt.", + "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequest", + "properties": { + "contents": { + "description": "Optional. Input content to augment, only text format is supported for now.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "model": { + "$ref": "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel", + "description": "Optional. Metadata of the backend deployed model." + }, + "vertexRagStore": { + "$ref": "GoogleCloudAiplatformV1beta1VertexRagStore", + "description": "Optional. Retrieves contexts from the Vertex RagStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel": { + "description": "Metadata of the backend deployed model.", + "id": "GoogleCloudAiplatformV1beta1AugmentPromptRequestModel", + "properties": { + "model": { + "description": "Optional. The model that the user will send the augmented prompt for content generation.", + "type": "string" + }, + "modelVersion": { + "description": "Optional. The model version of the backend deployed model.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1AugmentPromptResponse": { + "description": "Response message for AugmentPrompt.", + "id": "GoogleCloudAiplatformV1beta1AugmentPromptResponse", + "properties": { + "augmentedPrompt": { + "description": "Augmented prompt, only text format is supported for now.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, + "facts": { + "description": "Retrieved facts from RAG data sources.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Fact" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1AuthConfig": { "description": "Auth configuration to run the extension.", "id": "GoogleCloudAiplatformV1beta1AuthConfig", @@ -22005,11 +22250,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest": { - "description": "Request message for FeaturestoreService.BatchCreateFeatures.", + "description": "Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures.", "id": "GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest", "properties": { "requests": { - "description": "Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.", + "description": "Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message.", "items": { "$ref": "GoogleCloudAiplatformV1beta1CreateFeatureRequest" }, @@ -22854,6 +23099,43 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "usageMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata", + "description": "Output only. Metadata on the usage of the cached content.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata": { + "description": "Metadata on the usage of the cached content.", + "id": "GoogleCloudAiplatformV1beta1CachedContentUsageMetadata", + "properties": { + "audioDurationSeconds": { + "description": "Duration of audio in seconds.", + "format": "int32", + "type": "integer" + }, + "imageCount": { + "description": "Number of images.", + "format": "int32", + "type": "integer" + }, + "textCount": { + "description": "Number of text characters.", + "format": "int32", + "type": "integer" + }, + "totalTokenCount": { + "description": "Total number of tokens that the cached content consumes.", + "format": "int32", + "type": "integer" + }, + "videoDurationSeconds": { + "description": "Duration of video in seconds.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -22971,6 +23253,11 @@ "readOnly": true, "type": "integer" }, + "logprobsResult": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", + "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "readOnly": true + }, "safetyRatings": { "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { @@ -23072,6 +23359,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Claim": { + "description": "Claim that is extracted from the input text and facts that support it.", + "id": "GoogleCloudAiplatformV1beta1Claim", + "properties": { + "endIndex": { + "description": "Index in the input text where the claim ends (exclusive).", + "format": "int32", + "type": "integer" + }, + "factIndexes": { + "description": "Indexes of the facts supporting this claim.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "score": { + "description": "Confidence score of this corroboration.", + "format": "float", + "type": "number" + }, + "startIndex": { + "description": "Index in the input text where the claim starts (inclusive).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CoherenceInput": { "description": "Input for coherence metric.", "id": "GoogleCloudAiplatformV1beta1CoherenceInput", @@ -23400,6 +23717,88 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CorpusStatus": { + "description": "RagCorpus status.", + "id": "GoogleCloudAiplatformV1beta1CorpusStatus", + "properties": { + "errorStatus": { + "description": "Output only. Only when the `state` field is ERROR.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. RagCorpus life state.", + "enum": [ + "UNKNOWN", + "INITIALIZED", + "ACTIVE", + "ERROR" + ], + "enumDescriptions": [ + "This state is not supposed to happen.", + "RagCorpus resource entry is initialized, but hasn't done validation.", + "RagCorpus is provisioned successfully and is ready to serve.", + "RagCorpus is in a problematic situation. See `error_message` field for details." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CorroborateContentRequest": { + "description": "Request message for CorroborateContent.", + "id": "GoogleCloudAiplatformV1beta1CorroborateContentRequest", + "properties": { + "content": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. Input content to corroborate, only text format is supported for now." + }, + "facts": { + "description": "Optional. Facts used to generate the text can also be used to corroborate the text.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Fact" + }, + "type": "array" + }, + "parameters": { + "$ref": "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters", + "description": "Optional. Parameters that can be set to override default settings per request." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters": { + "description": "Parameters that can be overrided per request.", + "id": "GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters", + "properties": { + "citationThreshold": { + "description": "Optional. Only return claims with citation score larger than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CorroborateContentResponse": { + "description": "Response message for CorroborateContent.", + "id": "GoogleCloudAiplatformV1beta1CorroborateContentResponse", + "properties": { + "claims": { + "description": "Claims that are extracted from the input content and facts that support the claims.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Claim" + }, + "type": "array" + }, + "corroborationScore": { + "description": "Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CountTokensRequest": { "description": "Request message for PredictionService.CountTokens.", "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", @@ -23411,6 +23810,10 @@ }, "type": "array" }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", + "description": "Optional. Generation config that the model will use to generate the response." + }, "instances": { "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { @@ -24828,6 +25231,13 @@ "description": "Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured.", "readOnly": true }, + "pscAutomationConfigs": { + "description": "Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PSCAutomationConfig" + }, + "type": "array" + }, "reservedIpRanges": { "description": "Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges.", "items": { @@ -26935,6 +27345,34 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Fact": { + "description": "The fact used in grounding.", + "id": "GoogleCloudAiplatformV1beta1Fact", + "properties": { + "query": { + "description": "Query that is used to retrieve this fact.", + "type": "string" + }, + "summary": { + "description": "If present, the summary/snippet of the fact.", + "type": "string" + }, + "title": { + "description": "If present, it refers to the title of this fact.", + "type": "string" + }, + "uri": { + "description": "If present, this uri links to the source of the fact.", + "type": "string" + }, + "vectorDistance": { + "description": "If present, the distance between the query vector and this fact vector.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Feature": { "description": "Feature Metadata information. For example, color is a feature that describes an apple.", "id": "GoogleCloudAiplatformV1beta1Feature", @@ -27086,6 +27524,10 @@ "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." }, + "dense": { + "description": "Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores.", + "type": "boolean" + }, "entityIdColumns": { "description": "Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`.", "items": { @@ -27093,6 +27535,10 @@ }, "type": "array" }, + "staticDataSource": { + "description": "Optional. Set if the data source is not a time-series.", + "type": "boolean" + }, "timeSeries": { "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary." @@ -27504,6 +27950,10 @@ "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, + "optimizedConfig": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig", + "description": "Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore." + }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", "readOnly": true, @@ -27547,6 +27997,10 @@ "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", "deprecated": true, "description": "Optional. Deprecated: please use FeatureView.index_config instead." + }, + "vertexRagSource": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", + "description": "Optional. The Vertex RAG Source that the FeatureView is linked to." } }, "type": "object" @@ -27703,6 +28157,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig": { + "description": "Configuration for FeatureViews created in Optimized FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig", + "properties": { + "automaticResources": { + "$ref": "GoogleCloudAiplatformV1beta1AutomaticResources", + "description": "Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FeatureViewSync": { "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.", "id": "GoogleCloudAiplatformV1beta1FeatureViewSync", @@ -27848,6 +28313,22 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource": { + "description": "A Vertex Rag source for features that need to be synced to Online Store.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource", + "properties": { + "ragCorpusId": { + "description": "Optional. The RAG corpus id corresponding to this FeatureView.", + "format": "int64", + "type": "string" + }, + "uri": { + "description": "Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED)", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Featurestore": { "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1beta1Featurestore", @@ -28172,6 +28653,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FileStatus": { + "description": "RagFile status.", + "id": "GoogleCloudAiplatformV1beta1FileStatus", + "properties": { + "errorStatus": { + "description": "Output only. Only when the `state` field is ERROR.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. RagFile state.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "ERROR" + ], + "enumDescriptions": [ + "RagFile state is unspecified.", + "RagFile resource has been created and indexed successfully.", + "RagFile resource is in a problematic state. See `error_message` field for details." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FilterSplit": { "description": "Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. ", "id": "GoogleCloudAiplatformV1beta1FilterSplit", @@ -28548,7 +29056,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. The function response in JSON object format.", + "description": "Required. The function response in JSON object format. Use \"output\" key to specify function output and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as function output.", "type": "object" } }, @@ -28633,6 +29141,13 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" + }, "safetySettings": { "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", "items": { @@ -28670,6 +29185,11 @@ "readOnly": true, "type": "array" }, + "modelVersion": { + "description": "Output only. The model version used to generate the response.", + "readOnly": true, + "type": "string" + }, "promptFeedback": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", @@ -28725,6 +29245,12 @@ "description": "Usage metadata about response(s).", "id": "GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata", "properties": { + "cachedContentTokenCount": { + "description": "Output only. Number of tokens in the cached part in the input (the cached content).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "candidatesTokenCount": { "description": "Number of tokens in the response(s).", "format": "int32", @@ -28736,6 +29262,7 @@ "type": "integer" }, "totalTokenCount": { + "description": "Total token count for prompt and response candidates.", "format": "int32", "type": "integer" } @@ -28782,6 +29309,11 @@ "format": "float", "type": "number" }, + "logprobs": { + "description": "Optional. Logit probabilities.", + "format": "int32", + "type": "integer" + }, "maxOutputTokens": { "description": "Optional. The maximum number of output tokens to generate per message.", "format": "int32", @@ -28792,6 +29324,10 @@ "format": "float", "type": "number" }, + "responseLogprobs": { + "description": "Optional. If true, export the logprobs results in response.", + "type": "boolean" + }, "responseMimeType": { "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" @@ -29527,6 +30063,14 @@ "format": "int32", "type": "integer" }, + "partialFailureBigquerySink": { + "$ref": "GoogleCloudAiplatformV1beta1BigQueryDestination", + "description": "The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. \"bq://projectId.bqDatasetId.bqTableId\"). If the dataset id does not exist, it will be created. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table." + }, + "partialFailureGcsSink": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "The Cloud Storage path to write partial failures to." + }, "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." @@ -29535,6 +30079,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", "description": "Specifies the parsing config for RagFiles." }, + "sharePointSources": { + "$ref": "GoogleCloudAiplatformV1beta1SharePointSources", + "description": "SharePoint sources." + }, "slackSource": { "$ref": "GoogleCloudAiplatformV1beta1SlackSource", "description": "Slack channels with their corresponding access tokens." @@ -31168,6 +31716,62 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1LogprobsResult": { + "description": "Logprobs Result", + "id": "GoogleCloudAiplatformV1beta1LogprobsResult", + "properties": { + "chosenCandidates": { + "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" + }, + "type": "array" + }, + "topCandidates": { + "description": "Length = total number of decoding steps.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { + "description": "Candidate for the logprobs token and score.", + "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", + "properties": { + "logProbability": { + "description": "The candidate's log probability.", + "format": "float", + "type": "number" + }, + "token": { + "description": "The candidate’s token string value.", + "type": "string" + }, + "tokenId": { + "description": "The candidate’s token id value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { + "description": "Candidates with top log probabilities at each decoding step.", + "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", + "properties": { + "candidates": { + "description": "Sorted by log probability in descending order.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1LookupStudyRequest": { "description": "Request message for VizierService.LookupStudy.", "id": "GoogleCloudAiplatformV1beta1LookupStudyRequest", @@ -34807,6 +35411,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PSCAutomationConfig": { + "description": "PSC config that is used to automatically create forwarding rule via ServiceConnectionMap.", + "id": "GoogleCloudAiplatformV1beta1PSCAutomationConfig", + "properties": { + "network": { + "description": "Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.", + "type": "string" + }, + "projectId": { + "description": "Required. Project id used to create forwarding rule.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PairwiseMetricInput": { "description": "Input for pairwise metric.", "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", @@ -35281,6 +35900,12 @@ "description": "The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network.", "type": "string" }, + "originalPipelineJobId": { + "description": "Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "pipelineSpec": { "additionalProperties": { "description": "Properties of the object.", @@ -35289,6 +35914,14 @@ "description": "The spec of the pipeline.", "type": "object" }, + "pipelineTaskRerunConfigs": { + "description": "Output only. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig" + }, + "readOnly": true, + "type": "array" + }, "preflightValidations": { "description": "Optional. Whether to do component level validations before job creation.", "type": "boolean" @@ -35699,6 +36332,77 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig": { + "description": "User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts.", + "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig", + "properties": { + "inputs": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs", + "description": "Output only. The runtime input of the task overridden by the user.", + "readOnly": true + }, + "skipDownstreamTasks": { + "description": "Output only. Whether to skip downstream tasks. Default value is False.", + "readOnly": true, + "type": "boolean" + }, + "skipTask": { + "description": "Output only. Whether to skip this task. Default value is False.", + "readOnly": true, + "type": "boolean" + }, + "taskId": { + "description": "Output only. The system generated ID of the task. Retrieved from original run.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "taskName": { + "description": "Output only. The name of the task.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList": { + "description": "A list of artifact metadata.", + "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList", + "properties": { + "artifacts": { + "description": "Output only. A list of artifact metadata.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1RuntimeArtifact" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs": { + "description": "Runtime inputs data of the task.", + "id": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs", + "properties": { + "artifacts": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList" + }, + "description": "Output only. Input artifacts.", + "readOnly": true, + "type": "object" + }, + "parameterValues": { + "additionalProperties": { + "type": "any" + }, + "description": "Output only. Input parameters.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PipelineTemplateMetadata": { "description": "Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry.", "id": "GoogleCloudAiplatformV1beta1PipelineTemplateMetadata", @@ -35970,6 +36674,10 @@ "description": "Required. If true, expose the IndexEndpoint via private service connect.", "type": "boolean" }, + "enableSecurePrivateServiceConnect": { + "description": "Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled.", + "type": "boolean" + }, "projectAllowlist": { "description": "A list of Projects from which the forwarding rule will target the service attachment.", "items": { @@ -37035,7 +37743,7 @@ "type": "number" }, "sourceUri": { - "description": "For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", + "description": "If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", "type": "string" }, "sparseDistance": { @@ -37054,6 +37762,11 @@ "description": "A RagCorpus is a RagFile container and a project can have multiple RagCorpora.", "id": "GoogleCloudAiplatformV1beta1RagCorpus", "properties": { + "corpusStatus": { + "$ref": "GoogleCloudAiplatformV1beta1CorpusStatus", + "description": "Output only. RagCorpus state.", + "readOnly": true + }, "createTime": { "description": "Output only. Timestamp when this RagCorpus was created.", "format": "google-datetime", @@ -37077,6 +37790,10 @@ "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", "description": "Optional. Immutable. The embedding model config of the RagCorpus." }, + "ragVectorDbConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", + "description": "Optional. Immutable. The Vector DB config of the RagCorpus." + }, "updateTime": { "description": "Output only. Timestamp when this RagCorpus was last updated.", "format": "google-datetime", @@ -37192,6 +37909,11 @@ "description": "Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, + "fileStatus": { + "$ref": "GoogleCloudAiplatformV1beta1FileStatus", + "description": "Output only. State of the RagFile.", + "readOnly": true + }, "gcsSource": { "$ref": "GoogleCloudAiplatformV1beta1GcsSource", "description": "Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now.", @@ -37226,6 +37948,10 @@ "readOnly": true, "type": "string" }, + "sharePointSources": { + "$ref": "GoogleCloudAiplatformV1beta1SharePointSources", + "description": "The RagFile is imported from a SharePoint source." + }, "sizeBytes": { "description": "Output only. The size of the RagFile in bytes.", "format": "int64", @@ -37305,6 +38031,95 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfig": { + "description": "Config for the Vector DB to use for RAG.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfig", + "properties": { + "apiAuth": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuth", + "description": "Authentication config for the chosen Vector DB." + }, + "pinecone": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone", + "description": "The config for the Pinecone." + }, + "ragManagedDb": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", + "description": "The config for the RAG-managed Vector DB." + }, + "vertexFeatureStore": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", + "description": "The config for the Vertex Feature Store." + }, + "vertexVectorSearch": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch", + "description": "The config for the Vertex Vector Search." + }, + "weaviate": { + "$ref": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate", + "description": "The config for the Weaviate." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone": { + "description": "The config for the Pinecone.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone", + "properties": { + "indexName": { + "description": "Pinecone index name. This value cannot be changed after it's set.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb": { + "description": "The config for the default RAG-managed Vector DB.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore": { + "description": "The config for the Vertex Feature Store.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore", + "properties": { + "featureViewResourceName": { + "description": "The resource name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch": { + "description": "The config for the Vertex Vector Search.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch", + "properties": { + "index": { + "description": "The resource name of the Index. Format: `projects/{project}/locations/{location}/indexes/{index}`", + "type": "string" + }, + "indexEndpoint": { + "description": "The resource name of the Index Endpoint. Format: `projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate": { + "description": "The config for the Weaviate.", + "id": "GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate", + "properties": { + "collectionName": { + "description": "The corresponding collection this corpus maps to. This value cannot be changed after it's set.", + "type": "string" + }, + "httpEndpoint": { + "description": "Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RawPredictRequest": { "description": "Request message for PredictionService.RawPredict.", "id": "GoogleCloudAiplatformV1beta1RawPredictRequest", @@ -37657,6 +38472,29 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest": { + "description": "Request message for GenAiTuningService.RebaseTunedModel.", + "id": "GoogleCloudAiplatformV1beta1RebaseTunedModelRequest", + "properties": { + "artifactDestination": { + "$ref": "GoogleCloudAiplatformV1beta1GcsDestination", + "description": "Optional. The Google Cloud Storage location to write the artifacts." + }, + "deployToSameEndpoint": { + "description": "Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section.", + "type": "boolean" + }, + "tunedModelRef": { + "$ref": "GoogleCloudAiplatformV1beta1TunedModelRef", + "description": "Required. TunedModel reference to retrieve the legacy model information." + }, + "tuningJob": { + "$ref": "GoogleCloudAiplatformV1beta1TuningJob", + "description": "Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata": { "description": "Details of operations that perform reboot PersistentResource.", "id": "GoogleCloudAiplatformV1beta1RebootPersistentResourceOperationMetadata", @@ -38146,6 +38984,49 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RuntimeArtifact": { + "description": "The definition of a runtime artifact.", + "id": "GoogleCloudAiplatformV1beta1RuntimeArtifact", + "properties": { + "customProperties": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1Value" + }, + "deprecated": true, + "description": "The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.", + "type": "object" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Properties of the Artifact.", + "type": "object" + }, + "name": { + "description": "The name of an artifact.", + "type": "string" + }, + "properties": { + "additionalProperties": { + "$ref": "GoogleCloudAiplatformV1beta1Value" + }, + "deprecated": true, + "description": "The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead.", + "type": "object" + }, + "type": { + "$ref": "GoogleCloudAiplatformV1beta1ArtifactTypeSchema", + "description": "The type of the artifact." + }, + "uri": { + "description": "The URI of the artifact.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RuntimeConfig": { "description": "Runtime configuration to run the extension.", "id": "GoogleCloudAiplatformV1beta1RuntimeConfig", @@ -38239,14 +39120,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -38339,14 +39222,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "type": "string" }, @@ -38371,14 +39256,16 @@ "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", - "BLOCK_NONE" + "BLOCK_NONE", + "OFF" ], "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", - "Block none." + "Block none.", + "Turn off the safety filter." ], "type": "string" } @@ -38688,7 +39575,7 @@ "LOW_COST", "STANDARD", "SPOT", - "DWS_FLEX_START" + "FLEX_START" ], "enumDeprecated": [ false, @@ -38704,7 +39591,7 @@ "Deprecated. Low cost by making potential use of spot resources.", "Standard provisioning strategy uses regular on-demand resources.", "Spot provisioning strategy uses spot resources.", - "DWS Flex start strategy uses DWS to queue for resources." + "Flex Start strategy uses DWS to queue for resources." ], "type": "string" }, @@ -38717,9 +39604,16 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1Schema": { - "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). More fields may be added in the future as needed.", + "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": { + "anyOf": { + "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Schema" + }, + "type": "array" + }, "default": { "description": "Optional. Default value of the data.", "type": "any" @@ -38802,6 +39696,13 @@ "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", "type": "object" }, + "propertyOrdering": { + "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", + "items": { + "type": "string" + }, + "type": "array" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -42863,6 +43764,64 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SharePointSources": { + "description": "The SharePointSources to pass to ImportRagFiles.", + "id": "GoogleCloudAiplatformV1beta1SharePointSources", + "properties": { + "sharePointSources": { + "description": "The SharePoint sources.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource": { + "description": "An individual SharePointSource.", + "id": "GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource", + "properties": { + "clientId": { + "description": "The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions \"Files.ReadAll\", \"Sites.ReadAll\" and BrowserSiteLists.Read.All.", + "type": "string" + }, + "clientSecret": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", + "description": "The application secret for the app registered in Azure." + }, + "driveId": { + "description": "The ID of the drive to download from.", + "type": "string" + }, + "driveName": { + "description": "The name of the drive to download from.", + "type": "string" + }, + "fileId": { + "description": "Output only. The SharePoint file id. Output only.", + "readOnly": true, + "type": "string" + }, + "sharepointFolderId": { + "description": "The ID of the SharePoint folder to download from.", + "type": "string" + }, + "sharepointFolderPath": { + "description": "The path of the SharePoint folder to download from.", + "type": "string" + }, + "sharepointSiteName": { + "description": "The name of the SharePoint site to download from. This can be the site name or the site id.", + "type": "string" + }, + "tenantId": { + "description": "Unique identifier of the Azure Active Directory Instance.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ShieldedVmConfig": { "description": "A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm).", "id": "GoogleCloudAiplatformV1beta1ShieldedVmConfig", @@ -44257,7 +45216,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SupervisedTuningSpec": { - "description": "Tuning Spec for Supervised Tuning.", + "description": "Tuning Spec for Supervised Tuning for first party models.", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningSpec", "properties": { "hyperParameters": { @@ -44282,7 +45241,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse": { - "description": "Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "description": "Response message for FeatureOnlineStoreAdminService.SyncFeatureView.", "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse", "properties": { "featureViewSync": { @@ -44875,7 +45834,7 @@ "id": "GoogleCloudAiplatformV1beta1Tool", "properties": { "functionDeclarations": { - "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.", + "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration" }, @@ -45503,6 +46462,25 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1TunedModelRef": { + "description": "TunedModel Reference for legacy model migration.", + "id": "GoogleCloudAiplatformV1beta1TunedModelRef", + "properties": { + "pipelineJob": { + "description": "Support migration from tuning job list page, from bison model to gemini model.", + "type": "string" + }, + "tunedModel": { + "description": "Support migration from model registry.", + "type": "string" + }, + "tuningJob": { + "description": "Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1TuningDataStats": { "description": "The tuning data statistic values for TuningJob.", "id": "GoogleCloudAiplatformV1beta1TuningDataStats", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 1965d9b4ab..21fb419c76 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -201,7 +201,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -244,7 +244,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -355,7 +355,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -408,12 +408,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -451,12 +451,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -499,12 +499,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -625,7 +625,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -636,7 +636,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -709,7 +709,7 @@ ] }, "switchover": { - "description": "Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.", + "description": "Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover", "httpMethod": "POST", "id": "alloydb.projects.locations.clusters.switchover", @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "upgrade": { + "description": "Upgrades a single Cluster. Imperative only.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", + "httpMethod": "PATCH", + "id": "alloydb.projects.locations.clusters.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:upgrade", + "request": { + "$ref": "UpgradeClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -762,12 +790,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -805,12 +833,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -848,12 +876,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -951,7 +979,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -1060,7 +1088,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1071,7 +1099,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -1136,7 +1164,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1179,7 +1207,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1290,7 +1318,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1489,7 +1517,7 @@ } } }, - "revision": "20240823", + "revision": "20240923", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1578,19 +1606,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1742,7 +1773,7 @@ }, "sslConfig": { "$ref": "SslConfig", - "description": "Optional. SSL config option for this instance." + "description": "Optional. SSL configuration option for this instance." } }, "type": "object" @@ -1834,19 +1865,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -1976,7 +2010,7 @@ "TRIAL" ], "enumDescriptions": [ - "This is an unknown Subscription type (By default, Subscription Type is STANDARD)", + "This is an unknown subscription type. By default, the subscription type is STANDARD.", "Standard subscription.", "Trial subscription." ], @@ -2025,19 +2059,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2063,15 +2100,23 @@ "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -2244,11 +2289,11 @@ "id": "FailoverInstanceRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2350,11 +2395,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2459,7 +2504,7 @@ }, "networkConfig": { "$ref": "InstanceNetworkConfig", - "description": "Optional. Instance level network configuration." + "description": "Optional. Instance-level network configuration." }, "nodes": { "description": "Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.", @@ -2469,6 +2514,14 @@ "readOnly": true, "type": "array" }, + "outboundPublicIpAddresses": { + "description": "Output only. All outbound public IP addresses configured for the instance.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "pscInstanceConfig": { "$ref": "PscInstanceConfig", "description": "Optional. The configuration for Private Service Connect (PSC) for the instance." @@ -2543,7 +2596,7 @@ "type": "object" }, "InstanceNetworkConfig": { - "description": "Metadata related to instance level network configuration.", + "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { "authorizedExternalNetworks": { @@ -2553,6 +2606,10 @@ }, "type": "array" }, + "enableOutboundPublicIp": { + "description": "Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.", + "type": "boolean" + }, "enablePublicIp": { "description": "Optional. Enabling public ip for the instance.", "type": "boolean" @@ -2588,15 +2645,23 @@ "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -3001,11 +3066,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3118,18 +3183,18 @@ "id": "RestartInstanceRequest", "properties": { "nodeIds": { - "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", + "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.", "items": { "type": "string" }, "type": "array" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3156,11 +3221,11 @@ "description": "ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed." }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3212,10 +3277,10 @@ false ], "enumDescriptions": [ - "SSL mode not specified. Defaults to ENCRYPTED_ONLY.", + "SSL mode is not specified. Defaults to ENCRYPTED_ONLY.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).", - "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.", + "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, for example, using GenerateClientCertificate.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced." ], @@ -3238,15 +3303,21 @@ "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", - "READ_POOL_UPGRADE" + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", - "This stage is for the custom checks done before upgrade.", - "This stage is for `pg_upgrade --check` run before upgrade.", - "This stage is primary upgrade.", - "This stage is read pool upgrade." + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." ], "type": "string" }, @@ -3254,15 +3325,23 @@ "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -3880,7 +3959,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata.", + "description": "Common model for database resource instance metadata. Next ID: 22", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4007,6 +4086,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, + "primaryResourceLocation": { + "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", + "type": "string" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." @@ -4019,6 +4102,10 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "tagsSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainTags", + "description": "Optional. Tags associated with this resources." + }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -4405,6 +4492,11 @@ "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" + }, + "shardCount": { + "description": "Optional. Number of shards (if applicable).", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -4505,6 +4597,11 @@ "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { + "durationBasedRetention": { + "description": "Duration based retention period i.e. 172800 seconds (2 days)", + "format": "google-duration", + "type": "string" + }, "quantityBasedRetention": { "format": "int32", "type": "integer" @@ -4515,12 +4612,14 @@ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", + "DURATION", "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", - "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", + "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ], "type": "string" @@ -4532,6 +4631,20 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainTags": { + "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", + "id": "StorageDatabasecenterPartnerapiV1mainTags", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The Tag key/value mappings.", + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", @@ -4734,19 +4847,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -4777,11 +4893,11 @@ "id": "SwitchoverClusterRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -4826,6 +4942,50 @@ }, "type": "object" }, + "UpgradeClusterRequest": { + "description": "Upgrades a cluster.", + "id": "UpgradeClusterRequest", + "properties": { + "etag": { + "description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", + "type": "boolean" + }, + "version": { + "description": "Required. The version the cluster is going to be upgraded to.", + "enum": [ + "DATABASE_VERSION_UNSPECIFIED", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "DEPRECATED - The database version is Postgres 13.", + "The database version is Postgres 14.", + "The database version is Postgres 15.", + "The database version is Postgres 16." + ], + "type": "string" + } + }, + "type": "object" + }, "UpgradeClusterResponse": { "description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", "id": "UpgradeClusterResponse", @@ -4845,15 +5005,23 @@ "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index f663f86292..fd79b66e23 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -201,7 +201,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -244,7 +244,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -355,7 +355,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -408,12 +408,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -451,12 +451,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -499,12 +499,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -625,7 +625,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -636,7 +636,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -709,7 +709,7 @@ ] }, "switchover": { - "description": "Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.", + "description": "Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover", "httpMethod": "POST", "id": "alloydb.projects.locations.clusters.switchover", @@ -790,12 +790,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -833,12 +833,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -876,12 +876,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -979,7 +979,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -1088,7 +1088,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1099,7 +1099,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -1164,7 +1164,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1207,7 +1207,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1318,7 +1318,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1517,7 +1517,7 @@ } } }, - "revision": "20240823", + "revision": "20240923", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1778,7 +1778,7 @@ }, "sslConfig": { "$ref": "SslConfig", - "description": "Optional. SSL config option for this instance." + "description": "Optional. SSL configuration option for this instance." } }, "type": "object" @@ -2049,7 +2049,7 @@ "TRIAL" ], "enumDescriptions": [ - "This is an unknown Subscription type (By default, Subscription Type is STANDARD)", + "This is an unknown subscription type. By default, the subscription type is STANDARD.", "Standard subscription.", "Trial subscription." ], @@ -2139,15 +2139,23 @@ "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -2334,11 +2342,11 @@ "id": "FailoverInstanceRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2464,11 +2472,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2577,7 +2585,7 @@ }, "networkConfig": { "$ref": "InstanceNetworkConfig", - "description": "Optional. Instance level network configuration." + "description": "Optional. Instance-level network configuration." }, "nodes": { "description": "Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.", @@ -2682,7 +2690,7 @@ "type": "object" }, "InstanceNetworkConfig": { - "description": "Metadata related to instance level network configuration.", + "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { "authorizedExternalNetworks": { @@ -2731,15 +2739,23 @@ "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -3190,11 +3206,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3307,18 +3323,18 @@ "id": "RestartInstanceRequest", "properties": { "nodeIds": { - "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", + "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.", "items": { "type": "string" }, "type": "array" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3345,11 +3361,11 @@ "description": "ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed." }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3401,10 +3417,10 @@ false ], "enumDescriptions": [ - "SSL mode not specified. Defaults to ENCRYPTED_ONLY.", + "SSL mode is not specified. Defaults to ENCRYPTED_ONLY.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).", - "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.", + "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, for example, using GenerateClientCertificate.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced." ], @@ -3427,15 +3443,21 @@ "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", - "READ_POOL_UPGRADE" + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", - "This stage is for the custom checks done before upgrade.", - "This stage is for `pg_upgrade --check` run before upgrade.", - "This stage is primary upgrade.", - "This stage is read pool upgrade." + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." ], "type": "string" }, @@ -3443,15 +3465,23 @@ "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -4069,7 +4099,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata.", + "description": "Common model for database resource instance metadata. Next ID: 22", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4196,6 +4226,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, + "primaryResourceLocation": { + "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", + "type": "string" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." @@ -4208,6 +4242,10 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "tagsSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainTags", + "description": "Optional. Tags associated with this resources." + }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -4594,6 +4632,11 @@ "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" + }, + "shardCount": { + "description": "Optional. Number of shards (if applicable).", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -4694,6 +4737,11 @@ "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { + "durationBasedRetention": { + "description": "Duration based retention period i.e. 172800 seconds (2 days)", + "format": "google-duration", + "type": "string" + }, "quantityBasedRetention": { "format": "int32", "type": "integer" @@ -4704,12 +4752,14 @@ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", + "DURATION", "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", - "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", + "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ], "type": "string" @@ -4721,6 +4771,20 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainTags": { + "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", + "id": "StorageDatabasecenterPartnerapiV1mainTags", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The Tag key/value mappings.", + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", @@ -4969,11 +5033,11 @@ "id": "SwitchoverClusterRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -5048,11 +5112,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" }, "version": { @@ -5102,15 +5166,23 @@ "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 83b6e90999..dd0ccb7645 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -201,7 +201,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -244,7 +244,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -355,7 +355,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -408,12 +408,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -451,12 +451,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -499,12 +499,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -625,7 +625,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -636,7 +636,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -709,7 +709,7 @@ ] }, "switchover": { - "description": "Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster.", + "description": "Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:switchover", "httpMethod": "POST", "id": "alloydb.projects.locations.clusters.switchover", @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "upgrade": { + "description": "Upgrades a single Cluster. Imperative only.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", + "httpMethod": "PATCH", + "id": "alloydb.projects.locations.clusters.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}:upgrade", + "request": { + "$ref": "UpgradeClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -762,12 +790,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -805,12 +833,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -848,12 +876,12 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -951,7 +979,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -1060,7 +1088,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1071,7 +1099,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "location": "query", "type": "boolean" } @@ -1136,7 +1164,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1179,7 +1207,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1290,7 +1318,7 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -1486,7 +1514,7 @@ } } }, - "revision": "20240823", + "revision": "20240923", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1736,7 +1764,7 @@ }, "sslConfig": { "$ref": "SslConfig", - "description": "Optional. SSL config option for this instance." + "description": "Optional. SSL configuration option for this instance." } }, "type": "object" @@ -2002,7 +2030,7 @@ "TRIAL" ], "enumDescriptions": [ - "This is an unknown Subscription type (By default, Subscription Type is STANDARD)", + "This is an unknown subscription type. By default, the subscription type is STANDARD.", "Standard subscription.", "Trial subscription." ], @@ -2092,15 +2120,23 @@ "description": "Upgrade status of the cluster.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -2287,11 +2323,11 @@ "id": "FailoverInstanceRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2417,11 +2453,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -2530,7 +2566,7 @@ }, "networkConfig": { "$ref": "InstanceNetworkConfig", - "description": "Optional. Instance level network configuration." + "description": "Optional. Instance-level network configuration." }, "nodes": { "description": "Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.", @@ -2630,7 +2666,7 @@ "type": "object" }, "InstanceNetworkConfig": { - "description": "Metadata related to instance level network configuration.", + "description": "Metadata related to instance-level network configuration.", "id": "InstanceNetworkConfig", "properties": { "authorizedExternalNetworks": { @@ -2679,15 +2715,23 @@ "description": "Upgrade status of the instance.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -3138,11 +3182,11 @@ "type": "string" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3255,18 +3299,18 @@ "id": "RestartInstanceRequest", "properties": { "nodeIds": { - "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", + "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances.", "items": { "type": "string" }, "type": "array" }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3293,11 +3337,11 @@ "description": "ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed." }, "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -3349,10 +3393,10 @@ false ], "enumDescriptions": [ - "SSL mode not specified. Defaults to ENCRYPTED_ONLY.", + "SSL mode is not specified. Defaults to ENCRYPTED_ONLY.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced. Clients may use locally self-signed certificates (default psql client behavior).", - "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, e.g. via GenerateClientCertificate.", + "SSL connections are required. CA verification enforced. Clients must have certificates signed by a Cluster CA, for example, using GenerateClientCertificate.", "SSL connections are optional. CA verification not enforced.", "SSL connections are required. CA verification not enforced." ], @@ -3375,15 +3419,21 @@ "STAGE_UNSPECIFIED", "ALLOYDB_PRECHECK", "PG_UPGRADE_CHECK", + "PREPARE_FOR_UPGRADE", "PRIMARY_INSTANCE_UPGRADE", - "READ_POOL_UPGRADE" + "READ_POOL_INSTANCES_UPGRADE", + "ROLLBACK", + "CLEANUP" ], "enumDescriptions": [ "Unspecified stage.", - "This stage is for the custom checks done before upgrade.", - "This stage is for `pg_upgrade --check` run before upgrade.", - "This stage is primary upgrade.", - "This stage is read pool upgrade." + "Pre-upgrade custom checks, not covered by pg_upgrade.", + "Pre-upgrade pg_upgrade checks.", + "Clone the original cluster.", + "Upgrade the primary instance(downtime).", + "This stage is read pool upgrade.", + "Rollback in case of critical failures.", + "Cleanup." ], "type": "string" }, @@ -3391,15 +3441,23 @@ "description": "Status of the stage.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } @@ -4017,7 +4075,7 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata.", + "description": "Common model for database resource instance metadata. Next ID: 22", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -4144,6 +4202,10 @@ "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, + "primaryResourceLocation": { + "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", + "type": "string" + }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." @@ -4156,6 +4218,10 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "tagsSet": { + "$ref": "StorageDatabasecenterPartnerapiV1mainTags", + "description": "Optional. Tags associated with this resources." + }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -4542,6 +4608,11 @@ "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" + }, + "shardCount": { + "description": "Optional. Number of shards (if applicable).", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -4642,6 +4713,11 @@ "StorageDatabasecenterPartnerapiV1mainRetentionSettings": { "id": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "properties": { + "durationBasedRetention": { + "description": "Duration based retention period i.e. 172800 seconds (2 days)", + "format": "google-duration", + "type": "string" + }, "quantityBasedRetention": { "format": "int32", "type": "integer" @@ -4652,12 +4728,14 @@ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", + "DURATION", "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", - "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", + "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ], "type": "string" @@ -4669,6 +4747,20 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainTags": { + "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", + "id": "StorageDatabasecenterPartnerapiV1mainTags", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The Tag key/value mappings.", + "type": "object" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainUserLabels": { "description": "Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels.", "id": "StorageDatabasecenterPartnerapiV1mainUserLabels", @@ -4917,11 +5009,11 @@ "id": "SwitchoverClusterRequest", "properties": { "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "validateOnly": { - "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete.", + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", "type": "boolean" } }, @@ -4987,6 +5079,50 @@ }, "type": "object" }, + "UpgradeClusterRequest": { + "description": "Upgrades a cluster.", + "id": "UpgradeClusterRequest", + "properties": { + "etag": { + "description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.", + "type": "boolean" + }, + "version": { + "description": "Required. The version the cluster is going to be upgraded to.", + "enum": [ + "DATABASE_VERSION_UNSPECIFIED", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "DEPRECATED - The database version is Postgres 13.", + "The database version is Postgres 14.", + "The database version is Postgres 15.", + "The database version is Postgres 16." + ], + "type": "string" + } + }, + "type": "object" + }, "UpgradeClusterResponse": { "description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", "id": "UpgradeClusterResponse", @@ -5006,15 +5142,23 @@ "description": "Status of upgrade operation.", "enum": [ "STATUS_UNSPECIFIED", + "NOT_STARTED", + "IN_PROGRESS", "SUCCESS", "FAILED", - "PARTIAL_SUCCESS" + "PARTIAL_SUCCESS", + "CANCEL_IN_PROGRESS", + "CANCELLED" ], "enumDescriptions": [ "Unspecified status.", + "Not started.", + "In progress.", "Operation succeeded.", "Operation failed.", - "Operation partially succeeded." + "Operation partially succeeded.", + "Cancel is in progress.", + "Cancellation complete." ], "type": "string" } diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index f60d55ca97..5c9d23de95 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -311,7 +311,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.", "flatPath": "v1alpha/accounts/{accountsId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.accounts.runAccessReport", @@ -1017,7 +1017,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.", "flatPath": "v1alpha/properties/{propertiesId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.properties.runAccessReport", @@ -4886,7 +4886,7 @@ } } }, - "revision": "20240823", + "revision": "20240929", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -6037,7 +6037,7 @@ "type": "string" }, "project": { - "description": "Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number}' Example: 'projects/1234'", + "description": "Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234'", "type": "string" }, "streamingExportEnabled": { diff --git a/discovery/analyticsadmin-v1beta.json b/discovery/analyticsadmin-v1beta.json index e0c3700baf..148bc7f38f 100644 --- a/discovery/analyticsadmin-v1beta.json +++ b/discovery/analyticsadmin-v1beta.json @@ -305,7 +305,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.", "flatPath": "v1beta/accounts/{accountsId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.accounts.runAccessReport", @@ -561,7 +561,7 @@ ] }, "runAccessReport": { - "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", + "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.", "flatPath": "v1beta/properties/{propertiesId}:runAccessReport", "httpMethod": "POST", "id": "analyticsadmin.properties.runAccessReport", @@ -1788,7 +1788,7 @@ } } }, - "revision": "20240823", + "revision": "20240916", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 38efb5d11b..bac2f1cf82 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -1022,7 +1022,7 @@ } } }, - "revision": "20240826", + "revision": "20240925", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { @@ -1555,7 +1555,7 @@ "type": "object" }, "messageRetentionDuration": { - "description": "Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.", + "description": "Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.", "format": "google-duration", "type": "string" }, diff --git a/discovery/androiddeviceprovisioning-v1.json b/discovery/androiddeviceprovisioning-v1.json index a6193694fa..48c7c65ea9 100644 --- a/discovery/androiddeviceprovisioning-v1.json +++ b/discovery/androiddeviceprovisioning-v1.json @@ -851,7 +851,7 @@ } } }, - "revision": "20231120", + "revision": "20240916", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { @@ -1291,6 +1291,10 @@ "description": "The device’s IMEI number. Validated on input.", "type": "string" }, + "imei2": { + "description": "The device’s second IMEI number.", + "type": "string" + }, "manufacturer": { "description": "The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names).", "type": "string" @@ -1299,6 +1303,10 @@ "description": "The device’s MEID number.", "type": "string" }, + "meid2": { + "description": "The device’s second MEID number.", + "type": "string" + }, "model": { "description": "The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible).", "type": "string" diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 618942c074..c8923322e8 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1168,7 +1168,7 @@ } } }, - "revision": "20240902", + "revision": "20240924", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1193,7 +1193,7 @@ "id": "AdvancedSecurityOverrides", "properties": { "commonCriteriaMode": { - "description": "Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required.", + "description": "Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured.", "enum": [ "COMMON_CRITERIA_MODE_UNSPECIFIED", "COMMON_CRITERIA_MODE_DISABLED", @@ -1206,6 +1206,22 @@ ], "type": "string" }, + "contentProtectionPolicy": { + "description": "Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above.", + "enum": [ + "CONTENT_PROTECTION_POLICY_UNSPECIFIED", + "CONTENT_PROTECTION_DISABLED", + "CONTENT_PROTECTION_ENFORCED", + "CONTENT_PROTECTION_USER_CHOICE" + ], + "enumDescriptions": [ + "Unspecified. Defaults to CONTENT_PROTECTION_DISABLED.", + "Content protection is disabled and the user cannot change this.", + "Content protection is enabled and the user cannot change this.Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15.", + "Content protection is not controlled by the policy. The user is allowed to choose the behavior of content protection.Supported on Android 15 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15." + ], + "type": "string" + }, "developerSettings": { "description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated).", "enum": [ @@ -2236,6 +2252,25 @@ "Common Criteria Mode is currently enabled." ], "type": "string" + }, + "policySignatureVerificationStatus": { + "description": "Output only. The status of policy signature verification.", + "enum": [ + "POLICY_SIGNATURE_VERIFICATION_STATUS_UNSPECIFIED", + "POLICY_SIGNATURE_VERIFICATION_DISABLED", + "POLICY_SIGNATURE_VERIFICATION_SUCCEEDED", + "POLICY_SIGNATURE_VERIFICATION_NOT_SUPPORTED", + "POLICY_SIGNATURE_VERIFICATION_FAILED" + ], + "enumDescriptions": [ + "Unspecified. The verification status has not been reported. This is set only if statusReportingSettings.commonCriteriaModeEnabled is false.", + "Policy signature verification is disabled on the device as common_criteria_mode is set to false.", + "Policy signature verification succeeded.", + "Policy signature verification is not supported, e.g. because the device has been enrolled with a CloudDPC version that does not support the policy signature verification.", + "The policy signature verification failed. The policy has not been applied." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -2760,6 +2795,10 @@ ], "type": "string" }, + "wifiRoamingPolicy": { + "$ref": "WifiRoamingPolicy", + "description": "Optional. Wi-Fi roaming policy." + }, "wifiSsidPolicy": { "$ref": "WifiSsidPolicy", "description": "Restrictions on which Wi-Fi SSIDs the device can connect to. Note that this does not affect which networks can be configured on the device. Supported on company-owned devices running Android 13 and above." @@ -5647,7 +5686,7 @@ "id": "ScreenBrightnessSettings", "properties": { "screenBrightness": { - "description": "Optional. The screen brightness between 1 and 255 where 1 is the lowest and 255 is the highest brightness. A value of 0 (default) means no screen brightness set. Any other value is rejected. screenBrightnessMode must be either BRIGHTNESS_AUTOMATIC or BRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9.", + "description": "Optional. The screen brightness between 1 and 255 where 1 is the lowest and 255 is the highest brightness. A value of 0 (default) means no screen brightness set. Any other value is rejected. screenBrightnessMode must be either BRIGHTNESS_AUTOMATIC or BRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.", "format": "int32", "type": "integer" }, @@ -5662,8 +5701,8 @@ "enumDescriptions": [ "Unspecified. Defaults to BRIGHTNESS_USER_CHOICE.", "The user is allowed to configure the screen brightness. screenBrightness must not be set.", - "The screen brightness mode is automatic in which the brightness is automatically adjusted and the user is not allowed to configure the screen brightness. screenBrightness can still be set and it is taken into account while the brightness is automatically adjusted. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9.", - "The screen brightness mode is fixed in which the brightness is set to screenBrightness and the user is not allowed to configure the screen brightness. screenBrightness must be set. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9." + "The screen brightness mode is automatic in which the brightness is automatically adjusted and the user is not allowed to configure the screen brightness. screenBrightness can still be set and it is taken into account while the brightness is automatically adjusted. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.", + "The screen brightness mode is fixed in which the brightness is set to screenBrightness and the user is not allowed to configure the screen brightness. screenBrightness must be set. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above." ], "type": "string" } @@ -5675,7 +5714,7 @@ "id": "ScreenTimeoutSettings", "properties": { "screenTimeout": { - "description": "Optional. Controls the screen timeout duration. The screen timeout duration must be greater than 0, otherwise it is rejected. Additionally, it should not be greater than maximumTimeToLock, otherwise the screen timeout is set to maximumTimeToLock and a NonComplianceDetail with INVALID_VALUE reason and SCREEN_TIMEOUT_GREATER_THAN_MAXIMUM_TIME_TO_LOCK specific reason is reported. If the screen timeout is less than a certain lower bound, it is set to the lower bound. The lower bound may vary across devices. If this is set, screenTimeoutMode must be SCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9.", + "description": "Optional. Controls the screen timeout duration. The screen timeout duration must be greater than 0, otherwise it is rejected. Additionally, it should not be greater than maximumTimeToLock, otherwise the screen timeout is set to maximumTimeToLock and a NonComplianceDetail with INVALID_VALUE reason and SCREEN_TIMEOUT_GREATER_THAN_MAXIMUM_TIME_TO_LOCK specific reason is reported. If the screen timeout is less than a certain lower bound, it is set to the lower bound. The lower bound may vary across devices. If this is set, screenTimeoutMode must be SCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above.", "format": "google-duration", "type": "string" }, @@ -5689,7 +5728,7 @@ "enumDescriptions": [ "Unspecified. Defaults to SCREEN_TIMEOUT_USER_CHOICE.", "The user is allowed to configure the screen timeout. screenTimeout must not be set.", - "The screen timeout is set to screenTimeout and the user is not allowed to configure the timeout. screenTimeout must be set. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9." + "The screen timeout is set to screenTimeout and the user is not allowed to configure the timeout. screenTimeout must be set. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above." ], "type": "string" } @@ -6565,6 +6604,45 @@ }, "type": "object" }, + "WifiRoamingPolicy": { + "description": "Wi-Fi roaming policy.", + "id": "WifiRoamingPolicy", + "properties": { + "wifiRoamingSettings": { + "description": "Optional. Wi-Fi roaming settings. SSIDs provided in this list must be unique, the policy will be rejected otherwise.", + "items": { + "$ref": "WifiRoamingSetting" + }, + "type": "array" + } + }, + "type": "object" + }, + "WifiRoamingSetting": { + "description": "Wi-Fi roaming setting.", + "id": "WifiRoamingSetting", + "properties": { + "wifiRoamingMode": { + "description": "Required. Wi-Fi roaming mode for the specified SSID.", + "enum": [ + "WIFI_ROAMING_MODE_UNSPECIFIED", + "WIFI_ROAMING_DEFAULT", + "WIFI_ROAMING_AGGRESSIVE" + ], + "enumDescriptions": [ + "Unspecified. Defaults to WIFI_ROAMING_DEFAULT.", + "Default Wi-Fi roaming mode of the device.", + "Aggressive roaming mode which allows quicker Wi-Fi roaming. Supported on Android 15 and above on fully managed devices and work profiles on company-owned devices. A nonComplianceDetail with MANAGEMENT_MODE is reported for other management modes. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 15. A nonComplianceDetail with DEVICE_INCOMPATIBLE is reported if the device does not support aggressive roaming mode." + ], + "type": "string" + }, + "wifiSsid": { + "description": "Required. SSID of the Wi-Fi network.", + "type": "string" + } + }, + "type": "object" + }, "WifiSsid": { "description": "Represents a Wi-Fi SSID.", "id": "WifiSsid", diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 8dfab712e6..67a28db42d 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -723,7 +723,7 @@ "accept": [ "application/octet-stream" ], - "maxSize": "10737418240", + "maxSize": "53687091200", "protocols": { "resumable": { "multipart": true, @@ -4732,7 +4732,7 @@ } } }, - "revision": "20240821", + "revision": "20241003", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -5253,7 +5253,7 @@ "type": "string" }, "billingPeriodDuration": { - "description": "Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.", + "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.", "type": "string" }, "gracePeriodDuration": { @@ -6227,17 +6227,6 @@ }, "type": "object" }, - "ExternalOfferInitialAcquisitionDetails": { - "description": "Details about the first time a user/device completed a transaction using external offers.", - "id": "ExternalOfferInitialAcquisitionDetails", - "properties": { - "externalTransactionId": { - "description": "Required. The external transaction id of the first completed purchase made by the user.", - "type": "string" - } - }, - "type": "object" - }, "ExternalSubscription": { "description": "Details of an external subscription.", "id": "ExternalSubscription", @@ -6279,10 +6268,6 @@ "description": "Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction.", "readOnly": true }, - "externalOfferInitialAcquisitionDetails": { - "$ref": "ExternalOfferInitialAcquisitionDetails", - "description": "Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only." - }, "externalTransactionId": { "description": "Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction.", "readOnly": true, @@ -7085,11 +7070,11 @@ "type": "string" }, "billingPeriodDuration": { - "description": "Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.", + "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.", "type": "string" }, "committedPaymentsCount": { - "description": "Required. The number of payments the user is committed to.", + "description": "Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created.", "format": "int32", "type": "integer" }, @@ -7112,7 +7097,7 @@ "type": "string" }, "renewalType": { - "description": "Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment.", + "description": "Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created.", "enum": [ "RENEWAL_TYPE_UNSPECIFIED", "RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT", @@ -7748,7 +7733,7 @@ "id": "PrepaidBasePlanType", "properties": { "billingPeriodDuration": { - "description": "Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center.", + "description": "Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created.", "type": "string" }, "timeExtension": { @@ -8671,7 +8656,7 @@ "type": "string" }, "phases": { - "description": "Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation.", + "description": "Required. The phases of this subscription offer. Must contain at least one and at most two entries. Users will always receive all these phases in the specified order.", "items": { "$ref": "SubscriptionOfferPhase" }, diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index edd0f91a59..e6ef9053df 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -181,7 +181,7 @@ "type": "string" }, "retention": { - "description": "Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. **Note: During the data retention period specified using this field, the Apigee organization cannot be recreated in the same GCP project.**", + "description": "Optional. This setting is applicable only for organizations that are soft-deleted (i.e., BillingType is not EVALUATION). It controls how long Organization data will be retained after the initial delete operation completes. During this period, the Organization may be restored to its last known state. After this period, the Organization will no longer be able to be restored. **Note: During the data retention period specified using this field, the Apigee organization cannot be recreated in the same Google Cloud project.**", "enum": [ "DELETION_RETENTION_UNSPECIFIED", "MINIMUM" @@ -227,6 +227,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getControlPlaneAccess": { + "description": "Lists the service accounts allowed to access Apigee control plane directly for limited functionality. **Note**: Available to Apigee hybrid only.", + "flatPath": "v1/organizations/{organizationsId}/controlPlaneAccess", + "httpMethod": "GET", + "id": "apigee.organizations.getControlPlaneAccess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Resource name of the Control Plane Access. Use the following structure in your request: `organizations/{org}/controlPlaneAccess`", + "location": "path", + "pattern": "^organizations/[^/]+/controlPlaneAccess$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1ControlPlaneAccess" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getDeployedIngressConfig": { "description": "Gets the deployed ingress configuration for an organization.", "flatPath": "v1/organizations/{organizationsId}/deployedIngressConfig", @@ -479,6 +504,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateControlPlaneAccess": { + "description": "Updates the permissions required to allow Apigee runtime-plane components access to the control plane. Currently, the permissions required are to: 1. Allow runtime components to publish analytics data to the control plane. **Note**: Available to Apigee hybrid only.", + "flatPath": "v1/organizations/{organizationsId}/controlPlaneAccess", + "httpMethod": "PATCH", + "id": "apigee.organizations.updateControlPlaneAccess", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the ControlPlaneAccess. Format: \"organizations/{org}/controlPlaneAccess\"", + "location": "path", + "pattern": "^organizations/[^/]+/controlPlaneAccess$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated. Fields that can be updated: synchronizer_identities, publisher_identities.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1ControlPlaneAccess" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateSecuritySettings": { "description": "UpdateSecuritySettings updates the current security settings for API Security.", "flatPath": "v1/organizations/{organizationsId}/securitySettings", @@ -5402,6 +5461,62 @@ }, "deployments": { "methods": { + "get": { + "description": "Gets a particular deployment of Api proxy or a shared flow in an environment", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}", + "httpMethod": "GET", + "id": "apigee.organizations.environments.deployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the api proxy or the shared flow deployment. Use the following structure in your request: `organizations/{org}/environments/{env}/deployments/{deployment}`", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1Deployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the IAM policy on a deployment. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.getIamPolicy` permission to call this API.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:getIamPolicy", + "httpMethod": "GET", + "id": "apigee.organizations.environments.deployments.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all deployments of API proxies or shared flows in an environment.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments", @@ -5431,6 +5546,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets the IAM policy on a deployment, if the policy already exists it will be replaced. For more information, see [Manage users, roles, and permissions using the API](https://cloud.google.com/apigee/docs/api-platform/system-administration/manage-users-roles). You must have the `apigee.deployments.setIamPolicy` permission to call this API.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:setIamPolicy", + "httpMethod": "POST", + "id": "apigee.organizations.environments.deployments.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Tests the permissions of a user on a deployment, and returns a subset of permissions that the user has on the deployment. If the deployment does not exist, an empty permission set is returned (a NOT_FOUND error is not returned).", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/deployments/{deploymentsId}:testIamPermissions", + "httpMethod": "POST", + "id": "apigee.organizations.environments.deployments.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/deployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -9391,6 +9562,163 @@ } } }, + "securityProfilesV2": { + "methods": { + "create": { + "description": "Create a security profile v2.", + "flatPath": "v1/organizations/{organizationsId}/securityProfilesV2", + "httpMethod": "POST", + "id": "apigee.organizations.securityProfilesV2.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name.", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + }, + "securityProfileV2Id": { + "description": "Required. The security profile id.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityProfilesV2", + "request": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Delete a security profile v2.", + "flatPath": "v1/organizations/{organizationsId}/securityProfilesV2/{securityProfilesV2Id}", + "httpMethod": "DELETE", + "id": "apigee.organizations.securityProfilesV2.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the security profile v2 to delete.", + "location": "path", + "pattern": "^organizations/[^/]+/securityProfilesV2/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a security profile v2.", + "flatPath": "v1/organizations/{organizationsId}/securityProfilesV2/{securityProfilesV2Id}", + "httpMethod": "GET", + "id": "apigee.organizations.securityProfilesV2.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The security profile id.", + "location": "path", + "pattern": "^organizations/[^/]+/securityProfilesV2/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "List security profiles v2.", + "flatPath": "v1/organizations/{organizationsId}/securityProfilesV2", + "httpMethod": "GET", + "id": "apigee.organizations.securityProfilesV2.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of profiles to return", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListSecurityProfilesV2` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. For a specific organization, list of all the security profiles. Format: `organizations/{org}`", + "location": "path", + "pattern": "^organizations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/securityProfilesV2", + "response": { + "$ref": "GoogleCloudApigeeV1ListSecurityProfilesV2Response" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Update a security profile V2.", + "flatPath": "v1/organizations/{organizationsId}/securityProfilesV2/{securityProfilesV2Id}", + "httpMethod": "PATCH", + "id": "apigee.organizations.securityProfilesV2.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}", + "location": "path", + "pattern": "^organizations/[^/]+/securityProfilesV2/[^/]+$", + "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": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "sharedflows": { "methods": { "create": { @@ -10045,7 +10373,7 @@ } } }, - "revision": "20240620", + "revision": "20241004", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -11762,6 +12090,31 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ControlPlaneAccess": { + "description": "ControlPlaneAccess is the request body and response body of UpdateControlPlaneAccess. and the response body of GetControlPlaneAccess. The input identities contains an array of service accounts to grant access to the respective control plane resource, with each service account specified using the following format: `serviceAccount:`***service-account-name***. The ***service-account-name*** is formatted like an email address. For example: `my-control-plane-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one.", + "id": "GoogleCloudApigeeV1ControlPlaneAccess", + "properties": { + "analyticsPublisherIdentities": { + "description": "Optional. Array of service accounts authorized to publish analytics data to the control plane (for the Message Processor component).", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Identifier. The resource name of the ControlPlaneAccess. Format: \"organizations/{org}/controlPlaneAccess\"", + "type": "string" + }, + "synchronizerIdentities": { + "description": "Optional. Array of service accounts to grant access to control plane resources (for the Synchronizer component). The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts).", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1Credential": { "id": "GoogleCloudApigeeV1Credential", "properties": { @@ -12097,7 +12450,7 @@ "type": "string" }, "projectId": { - "description": "Required. GCP project in which the datastore exists", + "description": "Required. Google Cloud project in which the datastore exists", "type": "string" }, "tablePrefix": { @@ -14591,6 +14944,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListSecurityProfilesV2Response": { + "description": "Response for ListSecurityProfilesV2.", + "id": "GoogleCloudApigeeV1ListSecurityProfilesV2Response", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "securityProfilesV2": { + "description": "List of security profiles in the organization.", + "items": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListSecurityReportsResponse": { "description": "The response for SecurityReports.", "id": "GoogleCloudApigeeV1ListSecurityReportsResponse", @@ -16617,6 +16988,13 @@ "$ref": "GoogleCloudApigeeV1SecurityActionAllow", "description": "Allow a request through if it matches this SecurityAction." }, + "apiProxies": { + "description": "Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later.", + "items": { + "type": "string" + }, + "type": "array" + }, "conditionConfig": { "$ref": "GoogleCloudApigeeV1SecurityActionConditionConfig", "description": "Required. A valid SecurityAction must contain at least one condition." @@ -17225,6 +17603,68 @@ }, "type": "object" }, + "GoogleCloudApigeeV1SecurityProfileV2": { + "description": "Security profile for risk assessment version 2.", + "id": "GoogleCloudApigeeV1SecurityProfileV2", + "properties": { + "createTime": { + "description": "Output only. The time of the security profile creation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the security profile.", + "type": "string" + }, + "googleDefined": { + "description": "Output only. Whether the security profile is google defined.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}", + "type": "string" + }, + "profileAssessmentConfigs": { + "additionalProperties": { + "$ref": "GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig" + }, + "description": "Required. The configuration for each assessment in this profile. Key is the name/id of the assessment.", + "type": "object" + }, + "updateTime": { + "description": "Output only. The time of the security profile update.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig": { + "description": "The configuration definition for a specific assessment.", + "id": "GoogleCloudApigeeV1SecurityProfileV2ProfileAssessmentConfig", + "properties": { + "weight": { + "description": "The weight of the assessment.", + "enum": [ + "WEIGHT_UNSPECIFIED", + "MINOR", + "MODERATE", + "MAJOR" + ], + "enumDescriptions": [ + "The weight is unspecified.", + "The weight is minor.", + "The weight is moderate.", + "The weight is major." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1SecurityReport": { "description": "SecurityReport saves all the information about the created security report.", "id": "GoogleCloudApigeeV1SecurityReport", diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index f2c5befec5..ec5d3e3041 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -1718,7 +1718,7 @@ } } }, - "revision": "20240722", + "revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2480,6 +2480,24 @@ }, "type": "object" }, + "GceTag": { + "description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", + "id": "GceTag", + "properties": { + "parent": { + "description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tag": { + "description": "The administrative_tag name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -3343,6 +3361,13 @@ ], "type": "string" }, + "gceTag": { + "description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", + "items": { + "$ref": "GceTag" + }, + "type": "array" + }, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/discovery/appengine-v1alpha.json b/discovery/appengine-v1alpha.json index 7f8987ccc4..3f600d5341 100644 --- a/discovery/appengine-v1alpha.json +++ b/discovery/appengine-v1alpha.json @@ -946,7 +946,7 @@ } } }, - "revision": "20240422", + "revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { @@ -1125,6 +1125,24 @@ "properties": {}, "type": "object" }, + "GceTag": { + "description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", + "id": "GceTag", + "properties": { + "parent": { + "description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tag": { + "description": "The administrative_tag name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -1551,6 +1569,13 @@ ], "type": "string" }, + "gceTag": { + "description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", + "items": { + "$ref": "GceTag" + }, + "type": "array" + }, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 9eadfbb68d..0babd8eee6 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -1918,7 +1918,7 @@ } } }, - "revision": "20240722", + "revision": "20240906", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2731,6 +2731,24 @@ }, "type": "object" }, + "GceTag": { + "description": "For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info.", + "id": "GceTag", + "properties": { + "parent": { + "description": "The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "tag": { + "description": "The administrative_tag name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAppengineV1betaLocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleAppengineV1betaLocationMetadata", @@ -3594,6 +3612,13 @@ ], "type": "string" }, + "gceTag": { + "description": "The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE.", + "items": { + "$ref": "GceTag" + }, + "type": "array" + }, "p4ServiceAccount": { "description": "The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH.", "type": "string" diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index 68aa211a54..89b32dc905 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -679,7 +679,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name \"my-repo\" in project my-project in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo*\"`", + "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name `my-repo` in project `my-project` in the `us-central` region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo\"` * `name=\"projects/my-project/locations/us-central1/repositories/*repo*\"`", "location": "query", "type": "string" }, @@ -881,6 +881,136 @@ } } }, + "attachments": { + "methods": { + "create": { + "description": "Creates an attachment. The returned Operation will finish once the attachment has been created. Its response will be the created attachment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/attachments", + "httpMethod": "POST", + "id": "artifactregistry.projects.locations.repositories.attachments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "attachmentId": { + "description": "Required. The attachment id to use for this attachment.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource where the attachment will be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/attachments", + "request": { + "$ref": "Attachment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an attachment. The returned Operation will finish once the attachments has been deleted. It will not have any Operation metadata and will return a `google.protobuf.Empty` response.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/attachments/{attachmentsId}", + "httpMethod": "DELETE", + "id": "artifactregistry.projects.locations.repositories.attachments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the attachment to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/attachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets an attachment.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/attachments/{attachmentsId}", + "httpMethod": "GET", + "id": "artifactregistry.projects.locations.repositories.attachments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the attachment to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/attachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Attachment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists attachments.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/attachments", + "httpMethod": "GET", + "id": "artifactregistry.projects.locations.repositories.attachments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `target` * `type` * `attachment_namespace`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of attachments to return. Maximum page size is 1,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent resource whose attachments will be listed.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/attachments", + "response": { + "$ref": "ListAttachmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } + }, "dockerImages": { "methods": { "get": { @@ -1044,7 +1174,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1080,6 +1210,84 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "patch": { + "description": "Updates a file.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files/{filesId}", + "httpMethod": "PATCH", + "id": "artifactregistry.projects.locations.repositories.files.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the file, for example: `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. If the file ID part contains slashes, they are escaped.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/files/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleDevtoolsArtifactregistryV1File" + }, + "response": { + "$ref": "GoogleDevtoolsArtifactregistryV1File" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upload": { + "description": "Directly uploads a file to a repository. The returned Operation will complete once the resources are uploaded.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/files:upload", + "httpMethod": "POST", + "id": "artifactregistry.projects.locations.repositories.files.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "resumable": { + "multipart": true, + "path": "/resumable/upload/v1/{+parent}/files:upload" + }, + "simple": { + "multipart": true, + "path": "/upload/v1/{+parent}/files:upload" + } + } + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the repository where the file will be uploaded.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/files:upload", + "request": { + "$ref": "UploadFileRequest" + }, + "response": { + "$ref": "UploadFileMediaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "supportsMediaUpload": true } } }, @@ -1488,7 +1696,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name \"my-package\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*package\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*\"` To filter the results of your request to packages with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request\": * \"annotations.external_link:external_link_value\" To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-package`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", + "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name `my-package` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*package\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/*pack*\"` To filter the results of your request to packages with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request\": * `\"annotations.external_link:external_link_value\"` To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-package`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1657,7 +1865,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1836,7 +2044,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name \"my-version\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*\"` To filter the results of your request to versions with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-version`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", + "description": "Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name `my-version` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/*version*\"` To filter the results of your request to versions with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-version`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1887,6 +2095,40 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ] + }, + "patch": { + "description": "Updates a version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/packages/{packagesId}/versions/{versionsId}", + "httpMethod": "PATCH", + "id": "artifactregistry.projects.locations.repositories.packages.versions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/packages/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Version" + }, + "response": { + "$ref": "Version" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1959,6 +2201,165 @@ } } }, + "rules": { + "methods": { + "create": { + "description": "Creates a rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/rules", + "httpMethod": "POST", + "id": "artifactregistry.projects.locations.repositories.rules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource where the rule will be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + }, + "ruleId": { + "description": "The rule id to use for this repository.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/rules", + "request": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "response": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/rules/{rulesId}", + "httpMethod": "DELETE", + "id": "artifactregistry.projects.locations.repositories.rules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the rule to delete.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/rules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/rules/{rulesId}", + "httpMethod": "GET", + "id": "artifactregistry.projects.locations.repositories.rules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the rule to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/rules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "list": { + "description": "Lists rules.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/rules", + "httpMethod": "GET", + "id": "artifactregistry.projects.locations.repositories.rules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of rules to return. Maximum page size is 1,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous list request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent repository whose rules will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/rules", + "response": { + "$ref": "ListRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates a rule.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/rules/{rulesId}", + "httpMethod": "PATCH", + "id": "artifactregistry.projects.locations.repositories.rules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the rule, for example: \"projects/p1/locations/us-central1/repositories/repo1/rules/rule1\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+/rules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "response": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "yumArtifacts": { "methods": { "import": { @@ -2038,7 +2439,7 @@ } } }, - "revision": "20240826", + "revision": "20241001", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2104,6 +2505,60 @@ }, "type": "object" }, + "Attachment": { + "description": "An Attachment refers to additional metadata that can be attached to artifacts in Artifact Registry. An attachment consists of one or more files.", + "id": "Attachment", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User annotations. These attributes can only be set and used by the user, and not by Artifact Registry. See https://google.aip.dev/128#annotations for more details such as format and size limitations.", + "type": "object" + }, + "attachmentNamespace": { + "description": "The namespace this attachment belongs to. E.g. If an Attachment is created by artifact analysis, namespace is set to `artifactanalysis.googleapis.com`.", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the attachment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "files": { + "description": "Required. The files that belong to this attachment. If the file ID part contains slashes, they are escaped. E.g. `projects/p1/locations/us-central1/repositories/repo1/files/sha:`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The name of the attachment. E.g. \"projects/p1/locations/us/repositories/repo/attachments/sbom\".", + "type": "string" + }, + "ociVersionName": { + "description": "Output only. The name of the OCI version that this attachment created. Only populated for Docker attachments. E.g. `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Required. The target the attachment is for, can be a Version, Package or Repository. E.g. \"projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1\".", + "type": "string" + }, + "type": { + "description": "Type of Attachment. E.g. `application/vnd.spdx+json`", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the attachment was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "BatchDeleteVersionsMetadata": { "description": "The metadata of an LRO from deleting multiple versions.", "id": "BatchDeleteVersionsMetadata", @@ -2264,6 +2719,17 @@ }, "type": "object" }, + "CommonRemoteRepository": { + "description": "Common remote repository settings type.", + "id": "CommonRemoteRepository", + "properties": { + "uri": { + "description": "Required. A common public repository base for remote repository.", + "type": "string" + } + }, + "type": "object" + }, "DockerImage": { "description": "DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes): * imageSizeBytes * mediaType * buildTime", "id": "DockerImage", @@ -2460,6 +2926,13 @@ "description": "Files store content that is potentially associated with Packages or Versions.", "id": "GoogleDevtoolsArtifactregistryV1File", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Client specified annotations.", + "type": "object" + }, "createTime": { "description": "Output only. The time when the File was created.", "format": "google-datetime", @@ -2627,6 +3100,50 @@ }, "type": "object" }, + "GoogleDevtoolsArtifactregistryV1Rule": { + "description": "A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met.", + "id": "GoogleDevtoolsArtifactregistryV1Rule", + "properties": { + "action": { + "description": "The action this rule makes.", + "enum": [ + "ACTION_UNSPECIFIED", + "ALLOW", + "DENY" + ], + "enumDescriptions": [ + "Action not specified.", + "Allow the operation.", + "Deny the operation." + ], + "type": "string" + }, + "condition": { + "$ref": "Expr", + "description": "Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects." + }, + "name": { + "description": "The name of the rule, for example: \"projects/p1/locations/us-central1/repositories/repo1/rules/rule1\".", + "type": "string" + }, + "operation": { + "enum": [ + "OPERATION_UNSPECIFIED", + "DOWNLOAD" + ], + "enumDescriptions": [ + "Operation not specified.", + "Download operation." + ], + "type": "string" + }, + "packageId": { + "description": "The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository.", + "type": "string" + } + }, + "type": "object" + }, "Hash": { "description": "A hash of file content.", "id": "Hash", @@ -2882,6 +3399,24 @@ }, "type": "object" }, + "ListAttachmentsResponse": { + "description": "The response from listing attachments.", + "id": "ListAttachmentsResponse", + "properties": { + "attachments": { + "description": "The Attachments returned.", + "items": { + "$ref": "Attachment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token to retrieve the next page of attachments, or empty if there are no more attachments to return.", + "type": "string" + } + }, + "type": "object" + }, "ListDockerImagesResponse": { "description": "The response from listing docker images.", "id": "ListDockerImagesResponse", @@ -3026,6 +3561,24 @@ }, "type": "object" }, + "ListRulesResponse": { + "description": "The response from listing rules.", + "id": "ListRulesResponse", + "properties": { + "nextPageToken": { + "description": "The token to retrieve the next page of rules, or empty if there are no more rules to return.", + "type": "string" + }, + "rules": { + "description": "The rules returned.", + "items": { + "$ref": "GoogleDevtoolsArtifactregistryV1Rule" + }, + "type": "array" + } + }, + "type": "object" + }, "ListTagsResponse": { "description": "The response from listing tags.", "id": "ListTagsResponse", @@ -3385,12 +3938,6 @@ }, "type": "object" }, - "PromoteArtifactMetadata": { - "description": "The metadata for promote artifact long running operation.", - "id": "PromoteArtifactMetadata", - "properties": {}, - "type": "object" - }, "PythonPackage": { "description": "PythonPackage represents a python artifact.", "id": "PythonPackage", @@ -3457,6 +4004,10 @@ "$ref": "AptRepository", "description": "Specific settings for an Apt remote repository." }, + "commonRepository": { + "$ref": "CommonRemoteRepository", + "description": "Common remote repository settings. Used as the RemoteRepository upstream URL instead of Predefined and Custom remote repositories. Google Cloud Console and Google Cloud CLI will map all the new remote repositories to this field." + }, "description": { "description": "The description of the remote source.", "type": "string" @@ -3745,6 +4296,28 @@ }, "type": "object" }, + "UploadFileMediaResponse": { + "description": "The response to upload a generic artifact.", + "id": "UploadFileMediaResponse", + "properties": { + "operation": { + "$ref": "Operation", + "description": "Operation that will be returned to the user." + } + }, + "type": "object" + }, + "UploadFileRequest": { + "description": "The request to upload a file.", + "id": "UploadFileRequest", + "properties": { + "fileId": { + "description": "Optional. The ID of the file. If left empty will default to sha256 digest of the content uploaded.", + "type": "string" + } + }, + "type": "object" + }, "UploadGenericArtifactMediaResponse": { "description": "The response to upload a generic artifact.", "id": "UploadGenericArtifactMediaResponse", @@ -3988,6 +4561,13 @@ "description": "The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes.", "id": "Version", "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Client specified annotations.", + "type": "object" + }, "createTime": { "description": "The time when the version was created.", "format": "google-datetime", @@ -4007,7 +4587,7 @@ "type": "object" }, "name": { - "description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\". If the package or version ID parts contain slashes, the slashes are escaped.", + "description": "The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.", "type": "string" }, "relatedTags": { diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index 5cee019a59..76c0734aec 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -720,7 +720,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -947,7 +947,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1156,7 +1156,7 @@ } } }, - "revision": "20240826", + "revision": "20241001", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { @@ -1674,7 +1674,7 @@ "type": "string" }, "name": { - "description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\". If the package or version ID parts contain slashes, the slashes are escaped.", + "description": "The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.", "type": "string" }, "relatedTags": { diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index 71a5c047dc..ceb897d92d 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -882,7 +882,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name \"my_file.txt\" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * \"annotations.external_link:external_link_value\" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * \"annotations.external_link\" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * \"annotations.`external.link`:`https://example.com/my-file`\" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * \"annotations.*_link:`*example.com*`\"", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/my-*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file.txt\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/files/*file*\"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `\"annotations.external_link:external_link_value\"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `\"annotations.external_link\"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` \"annotations.`external.link`:`https://example.com/my-file`\" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` \"annotations.*_link:`*example.com*`\" ``", "location": "query", "type": "string" }, @@ -1143,7 +1143,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name \"my-tag\" in package \"my-package\" in repository \"my-repo\" in project \"my-project\" in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project \"`y-project` in the us-central region, append the following filter expression to your request: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag\"` You can also use wildcards to match any number of characters before or after the value: * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag\"` * `name=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/*tag*\"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version=\"projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0\"`", "location": "query", "type": "string" }, @@ -1424,7 +1424,7 @@ } } }, - "revision": "20240826", + "revision": "20241001", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2307,7 +2307,7 @@ "type": "object" }, "name": { - "description": "The name of the version, for example: \"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1\". If the package or version ID parts contain slashes, the slashes are escaped.", + "description": "The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped.", "type": "string" }, "relatedTags": { diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index fd030447a6..8c8928be22 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240823", + "revision": "20240913", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -699,7 +699,8 @@ "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", - "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT" + "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", + "IRS_1075" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -724,7 +725,8 @@ "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls", "Healthcare and Life Science Controls", - "Healthcare and Life Science Controls with US Support" + "Healthcare and Life Science Controls with US Support", + "Internal Revenue Service 1075 controls" ], "type": "string" }, @@ -1186,7 +1188,8 @@ "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", - "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT" + "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", + "IRS_1075" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1211,7 +1214,8 @@ "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls", "Healthcare and Life Science Controls", - "Healthcare and Life Science Controls with US Support" + "Healthcare and Life Science Controls with US Support", + "Internal Revenue Service 1075 controls" ], "type": "string" }, diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 4f7d3fa0ab..61ef72139d 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -471,6 +471,74 @@ } }, "resources": { + "updates": { + "methods": { + "apply": { + "description": "This endpoint creates a new operation to apply the given update.", + "flatPath": "v1beta1/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": "v1beta1/{+name}:apply", + "request": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "This endpoint lists all updates for the given workload.", + "flatPath": "v1beta1/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": "v1beta1/{+parent}/updates", + "response": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "violations": { "methods": { "acknowledge": { @@ -588,7 +656,7 @@ } } }, - "revision": "20240823", + "revision": "20240923", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -645,6 +713,65 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateOperationMetadata": { + "description": "Operation metadata to give request details of ApplyWorkloadUpdate.", + "id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateOperationMetadata", + "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" + }, + "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest": { + "description": "Request to apply update to a workload.", + "id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest", + "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" + }, + "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse": { + "description": "Response for ApplyWorkloadUpdate endpoint.", + "id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse", + "properties": { + "appliedUpdate": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate", + "description": "The update that was applied." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": { "description": "Represents move analysis results for an asset.", "id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis", @@ -696,7 +823,8 @@ "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", - "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT" + "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", + "IRS_1075" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -721,7 +849,8 @@ "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls", "Healthcare and Life Science Controls", - "Healthcare and Life Science Controls with US Support" + "Healthcare and Life Science Controls with US Support", + "Internal Revenue Service 1075 controls" ], "type": "string" }, @@ -778,6 +907,24 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse": { + "description": "Response of listing the compliance updates per workload with pagination.", + "id": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse", + "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": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse": { "description": "Response of ListWorkloads endpoint.", "id": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse", @@ -847,6 +994,92 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1OrgPolicy": { + "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": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy", + "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": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule", + "description": "The rule of the OrgPolicy." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule": { + "description": "A rule used to express this policy.", + "id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule", + "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": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues", + "description": "ListPolicy only when custom values are specified." + } + }, + "type": "object" + }, + "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues": { + "description": "The values allowed for a ListPolicy.", + "id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues", + "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" + }, + "GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate": { + "description": "Represents an update for an org policy control applied on an Assured Workload resource. The inherited org policy is not considered.", + "id": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate", + "properties": { + "appliedPolicy": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy", + "description": "The org policy currently applied on the assured workload resource." + }, + "suggestedPolicy": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicy", + "description": "The suggested org policy that replaces the applied policy." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest": { "description": "Request for restricting list of available resources in Workload environment.", "id": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest", @@ -876,6 +1109,17 @@ "properties": {}, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1UpdateDetails": { + "description": "The details of the update.", + "id": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails", + "properties": { + "orgPolicyUpdate": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate", + "description": "Update to one org policy, e.g. gcp.resourceLocation." + } + }, + "type": "object" + }, "GoogleCloudAssuredworkloadsV1beta1Violation": { "description": "Workload monitoring Violation.", "id": "GoogleCloudAssuredworkloadsV1beta1Violation", @@ -1147,6 +1391,12 @@ "description": "A Workload object for managing highly regulated workloads of cloud customers.", "id": "GoogleCloudAssuredworkloadsV1beta1Workload", "properties": { + "availableUpdates": { + "description": "Output only. The number of updates available for the workload.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "billingAccount": { "description": "Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`.", "type": "string" @@ -1181,7 +1431,8 @@ "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS", "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS", - "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT" + "HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT", + "IRS_1075" ], "enumDescriptions": [ "Unknown compliance regime.", @@ -1206,7 +1457,8 @@ "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls", "Healthcare and Life Science Controls", - "Healthcare and Life Science Controls with US Support" + "Healthcare and Life Science Controls with US Support", + "Internal Revenue Service 1075 controls" ], "type": "string" }, @@ -1657,6 +1909,49 @@ }, "type": "object" }, + "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate": { + "description": "A workload update is a change to the workload's compliance configuration.", + "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate", + "properties": { + "createTime": { + "description": "The time the update was created.", + "format": "google-datetime", + "type": "string" + }, + "details": { + "$ref": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails", + "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" + }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json index 066dfe4016..b2d4ec6e54 100644 --- a/discovery/authorizedbuyersmarketplace-v1.json +++ b/discovery/authorizedbuyersmarketplace-v1.json @@ -1367,7 +1367,7 @@ } } }, - "revision": "20240625", + "revision": "20241002", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -3111,22 +3111,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json index 8b2b87d698..16f3e45bc2 100644 --- a/discovery/authorizedbuyersmarketplace-v1alpha.json +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -1550,7 +1550,7 @@ } } }, - "revision": "20240718", + "revision": "20241002", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { @@ -1969,7 +1969,7 @@ "properties": { "cpmFee": { "$ref": "Money", - "description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package." + "description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed." }, "createTime": { "description": "Output only. Time the data segment was created.", @@ -3366,22 +3366,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index e072f206a3..4592fb9403 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -489,7 +489,7 @@ "backupVaults": { "methods": { "create": { - "description": "", + "description": "Creates a new BackupVault in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", "httpMethod": "POST", "id": "backupdr.projects.locations.backupVaults.create", @@ -642,6 +642,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault", + "enum": [ + "BACKUP_VAULT_VIEW_UNSPECIFIED", + "BACKUP_VAULT_VIEW_BASIC", + "BACKUP_VAULT_VIEW_FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default 'FULL' view is used.", + "Includes basic data about the Backup Vault, but not the full contents.", + "Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault)." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -688,6 +703,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.", + "enum": [ + "BACKUP_VAULT_VIEW_UNSPECIFIED", + "BACKUP_VAULT_VIEW_BASIC", + "BACKUP_VAULT_VIEW_FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default 'FULL' view is used.", + "Includes basic data about the Backup Vault, but not the full contents.", + "Includes all data about the Backup Vault. This is the default value (for both ListBackupVaults and GetBackupVault)." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/backupVaults", @@ -713,7 +743,7 @@ "type": "boolean" }, "name": { - "description": "Output only. Identifier. The resource name.", + "description": "Output only. Identifier. Name of the backup vault to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}\"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", "required": true, @@ -977,7 +1007,7 @@ "type": "boolean" }, "name": { - "description": "Output only. Identifier. The resource name.", + "description": "Output only. Identifier. Name of the datasource to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}\"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", "required": true, @@ -1111,6 +1141,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.", + "enum": [ + "BACKUP_VIEW_UNSPECIFIED", + "BACKUP_VIEW_BASIC", + "BACKUP_VIEW_FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default 'FULL' view is used.", + "Includes basic data about the Backup, but not the full contents.", + "Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+name}", @@ -1157,6 +1202,21 @@ "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", "required": true, "type": "string" + }, + "view": { + "description": "Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.", + "enum": [ + "BACKUP_VIEW_UNSPECIFIED", + "BACKUP_VIEW_BASIC", + "BACKUP_VIEW_FULL" + ], + "enumDescriptions": [ + "If the value is not set, the default 'FULL' view is used.", + "Includes basic data about the Backup, but not the full contents.", + "Includes all data about the Backup. This is the default value (for both ListBackups and GetBackup)." + ], + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/backups", @@ -1177,7 +1237,7 @@ ], "parameters": { "name": { - "description": "Output only. Identifier. Name of the resource.", + "description": "Output only. Identifier. Name of the backup to create. It must have the format`\"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}\"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", "required": true, @@ -1598,7 +1658,7 @@ } } }, - "revision": "20240815", + "revision": "20240920", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -2066,7 +2126,7 @@ "type": "object" }, "name": { - "description": "Output only. Identifier. Name of the resource.", + "description": "Output only. Identifier. Name of the backup to create. It must have the format`\"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}\"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.", "readOnly": true, "type": "string" }, @@ -2278,7 +2338,7 @@ "type": "object" }, "BackupPlan": { - "description": "A `BackupPlan` specifies some common fields, such as `display_name` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.", + "description": "A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.", "id": "BackupPlan", "properties": { "backupRules": { @@ -2448,6 +2508,22 @@ "description": "Message describing a BackupVault object.", "id": "BackupVault", "properties": { + "accessRestriction": { + "description": "Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.", + "enum": [ + "ACCESS_RESTRICTION_UNSPECIFIED", + "WITHIN_PROJECT", + "WITHIN_ORGANIZATION", + "UNRESTRICTED" + ], + "enumDescriptions": [ + "Access restriction not set.", + "Access to or from resources outside your current project will be denied.", + "Access to or from resources outside your current organization will be denied.", + "No access restriction." + ], + "type": "string" + }, "annotations": { "additionalProperties": { "type": "string" @@ -2498,7 +2574,7 @@ "type": "object" }, "name": { - "description": "Output only. Identifier. The resource name.", + "description": "Output only. Identifier. Name of the backup vault to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}\"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.", "readOnly": true, "type": "string" }, @@ -2668,6 +2744,13 @@ ], "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels to apply to instances that are created from these properties.", + "type": "object" + }, "machineType": { "description": "The machine type to use for instances that are created from these properties.", "type": "string" @@ -2989,7 +3072,7 @@ "type": "object" }, "name": { - "description": "Output only. Identifier. The resource name.", + "description": "Output only. Identifier. Name of the datasource to create. It must have the format`\"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}\"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.", "readOnly": true, "type": "string" }, @@ -3307,6 +3390,25 @@ }, "type": "object" }, + "GcpResource": { + "description": "Minimum details to identify a Google Cloud resource", + "id": "GcpResource", + "properties": { + "gcpResourcename": { + "description": "Name of the Google Cloud resource.", + "type": "string" + }, + "location": { + "description": "Location of the resource: //\"global\"/\"unspecified\".", + "type": "string" + }, + "type": { + "description": "Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", + "type": "string" + } + }, + "type": "object" + }, "GuestOsFeature": { "description": "Feature type of the Guest OS.", "id": "GuestOsFeature", @@ -4372,6 +4474,17 @@ }, "type": "object" }, + "RestoreBackupResponse": { + "description": "Response message for restoring from a Backup.", + "id": "RestoreBackupResponse", + "properties": { + "targetResource": { + "$ref": "TargetResource", + "description": "Details of the target resource created/modified as part of restore." + } + }, + "type": "object" + }, "RuleConfigInfo": { "description": "Message for rules config info.", "id": "RuleConfigInfo", @@ -4581,6 +4694,12 @@ }, "type": "object" }, + "SetInternalStatusResponse": { + "description": "Response message from SetStatusInternal method.", + "id": "SetInternalStatusResponse", + "properties": {}, + "type": "object" + }, "SpannerLocation": { "id": "SpannerLocation", "properties": { @@ -4758,6 +4877,17 @@ }, "type": "object" }, + "TargetResource": { + "description": "Details of the target resource created/modified as part of restore.", + "id": "TargetResource", + "properties": { + "gcpResource": { + "$ref": "GcpResource", + "description": "Details of the native Google Cloud resource created as part of restore." + } + }, + "type": "object" + }, "TenantProjectProxy": { "id": "TenantProjectProxy", "properties": { diff --git a/discovery/baremetalsolution-v2.json b/discovery/baremetalsolution-v2.json index 0194c109df..394af57f49 100644 --- a/discovery/baremetalsolution-v2.json +++ b/discovery/baremetalsolution-v2.json @@ -1722,7 +1722,7 @@ } } }, - "revision": "20240422", + "revision": "20240830", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { @@ -2847,7 +2847,7 @@ "type": "string" }, "vlanAttachments": { - "description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan).", + "description": "List of VLAN attachments. As of now there are always 2 attachments, but it is going to change in the future (multi vlan). Use only one of vlan_attachments or vrf", "items": { "$ref": "IntakeVlanAttachment" }, @@ -2856,6 +2856,10 @@ "vlanSameProject": { "description": "Whether the VLAN attachment pair is located in the same project.", "type": "boolean" + }, + "vrf": { + "description": "Optional. The name of a pre-existing Vrf that the network should be attached to. Format is `vrfs/{vrf}`. If vrf is specified, vlan_attachments must be empty.", + "type": "string" } }, "type": "object" diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 15ae00738c..babc2aa5d5 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20240821", + "revision": "20240925", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1001,7 +1001,7 @@ "additionalProperties": { "type": "string" }, - "description": "Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with \"goog-\" or \"google-\" are reserved.", + "description": "Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with \"goog-\" or \"google-\" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).", "type": "object" }, "location": { @@ -1264,7 +1264,7 @@ "type": "string" }, "reservation": { - "description": "Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation.", + "description": "Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation. Additionally, VMs will not consume any reservation if \"NO_RESERVATION\" is specified.", "type": "string" } }, @@ -1287,7 +1287,7 @@ "type": "boolean" }, "instanceTemplate": { - "description": "Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict.", + "description": "Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict. Batch only supports global instance templates. You can specify the global instance template as a full or partial URL.", "type": "string" }, "policy": { @@ -1351,7 +1351,7 @@ "additionalProperties": { "type": "string" }, - "description": "Labels for the Job. Labels could be user provided or system generated. For example, \"labels\": { \"department\": \"finance\", \"environment\": \"test\" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with \"goog-\" or \"google-\" are reserved.", + "description": "Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with \"goog-\" or \"google-\" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels).", "type": "object" }, "logsPolicy": { diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index 0bf72b7f61..cbe074a290 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -1713,6 +1713,95 @@ } } }, + "global": { + "resources": { + "securityGateways": { + "resources": { + "applications": { + "methods": { + "create": { + "description": "Creates a new Application in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.applications.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "applicationId": { + "description": "Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/applications", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Application.", + "flatPath": "v1/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "PATCH", + "id": "beyondcorp.projects.locations.global.securityGateways.applications.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Mutable fields include: display_name.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "operations": { "methods": { "cancel": { @@ -1835,13 +1924,340 @@ ] } } + }, + "securityGateways": { + "methods": { + "create": { + "description": "Creates a new SecurityGateway in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.securityGateways.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id}/locations/{location_id}`", + "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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + }, + "securityGatewayId": { + "description": "Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityGateways", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single SecurityGateway.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", + "httpMethod": "DELETE", + "id": "beyondcorp.projects.locations.securityGateways.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id}/locations/{location_id}/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single SecurityGateway.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the PartnerTenant using the form: `projects/{project_id}/locations/{location_id}/securityGateway/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists SecurityGateways in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName \"test-security-gateway\" For more information, please refer to https://google.aip.dev/160.", + "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 ListSecurityGatewayRequest, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/{location_id}/`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/securityGateways", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single SecurityGateway.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}", + "httpMethod": "PATCH", + "id": "beyondcorp.projects.locations.securityGateways.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Mutable fields include: display_name, hubs.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setPeering": { + "description": "This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.securityGateways.setPeering", + "parameterOrder": [ + "securityGateway" + ], + "parameters": { + "securityGateway": { + "description": "Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+securityGateway}:setPeering", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "applications": { + "methods": { + "delete": { + "description": "Deletes a single Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "DELETE", + "id": "beyondcorp.projects.locations.securityGateways.applications.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.applications.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Applications in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.applications.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/applications", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } } } }, - "revision": "20240802", + "revision": "20240925", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3072,6 +3488,284 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1Application": { + "description": "A Beyondcorp Application resource information.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Application", + "properties": { + "createTime": { + "description": "Output only. Timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. An arbitrary user-provided name for the Application resource. Cannot exceed 64 characters.", + "type": "string" + }, + "endpointMatchers": { + "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matcher is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one the conditions are met. The conditions can be one of the following combination (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.abc.com\"), (\"xyz.abc.com\") Hostname and Ports - (\"abc.com\" and \"22\"), (\"abc.com\" and \"22,33\") etc", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Name of the resource.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher": { + "description": "EndpointMatcher contains the information of the endpoint that will match the application.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher", + "properties": { + "hostname": { + "description": "Required. Hostname of the application.", + "type": "string" + }, + "ports": { + "description": "Optional. Ports of the application.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1Hub": { + "description": "The Hub message contains information pertaining to the regional data path deployments.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Hub", + "properties": { + "natGatewayConfig": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1NatGatewayConfig", + "description": "Optional. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits." + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse": { + "description": "Message for response to listing Applications.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse", + "properties": { + "applications": { + "description": "A list of BeyondCorp Application in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Application" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse": { + "description": "Message for response to listing SecurityGateways.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse", + "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" + }, + "securityGateways": { + "description": "A list of BeyondCorp SecurityGateway in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway" + }, + "type": "array" + }, + "unreachable": { + "description": "A list of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1NatGatewayConfig": { + "description": "Represents the NAT Gateway configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1NatGatewayConfig", + "properties": { + "natIps": { + "description": "Output only. List of NAT IPs that will be used for establishing connection to the endpoints.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1Peering": { + "description": "VPC Peering details.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1Peering", + "properties": { + "dnsZones": { + "description": "Optional. List of DNS zones for DNS peering with the customer VPC network.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetVpcNetwork": { + "description": "Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network}", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway": { + "description": "Information about a BeyoncCorp SecurityGateway resource.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway", + "properties": { + "createTime": { + "description": "Output only. Timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters.", + "type": "string" + }, + "externalIps": { + "description": "Output only. IP addresses that will be used for establishing connection to the endpoints.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "hubs": { + "additionalProperties": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Hub" + }, + "description": "Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.", + "type": "object" + }, + "name": { + "description": "Identifier. Name of the resource.", + "type": "string" + }, + "state": { + "description": "Output only. The operational state of the SecurityGateway.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "DELETING", + "RUNNING", + "DOWN", + "ERROR" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "SecurityGateway is being created.", + "SecurityGateway is being updated.", + "SecurityGateway is being deleted.", + "SecurityGateway is running.", + "SecurityGateway is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.", + "SecurityGateway encountered an error and is in an indeterministic state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata", + "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" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest": { + "description": "Set Peering request for creating a VPC peering between Google network and customer networks.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest", + "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" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "type": "boolean" + }, + "vpcPeerings": { + "description": "Required. List of Peering connection information.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1Peering" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGatewayOperationMetadata", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index 53e4fe2b9f..0776309f91 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -1264,10 +1264,7 @@ "path": "v1alpha/{+name}:cancel", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaCancelSubscriptionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, "create": { "description": "Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1292,10 +1289,7 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, "get": { "description": "Gets details of a single Subscription.", @@ -1317,10 +1311,7 @@ "path": "v1alpha/{+name}", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, "list": { "description": "Lists Subscriptions in a given organization and location.", @@ -1353,10 +1344,7 @@ "path": "v1alpha/{+parent}/subscriptions", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaListSubscriptionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, "patch": { "description": "Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1392,10 +1380,7 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } }, "restart": { "description": "Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective", @@ -1422,10 +1407,7 @@ "path": "v1alpha/{+name}:restart", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaRestartSubscriptionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } } @@ -3496,7 +3478,7 @@ ], "parameters": { "applicationId": { - "description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "description": "Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", "location": "query", "type": "string" }, @@ -3592,115 +3574,6 @@ ] } } - }, - "hubs": { - "methods": { - "create": { - "description": "Creates a new Hub in a given project and location.", - "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.global.securityGateways.hubs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "hubId": { - "description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+parent}/hubs", - "request": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the parameters of a single Hub.", - "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}", - "httpMethod": "PATCH", - "id": "beyondcorp.projects.locations.global.securityGateways.hubs.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. Name of the resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "updateMask": { - "description": "Required. Mutable fields include: display_name.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}:testIamPermissions", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.global.securityGateways.hubs.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } } } } @@ -3934,97 +3807,6 @@ } } }, - "netConnections": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:getIamPolicy", - "httpMethod": "GET", - "id": "beyondcorp.projects.locations.netConnections.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/[^/]+/netConnections/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:getIamPolicy", - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:setIamPolicy", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.netConnections.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/[^/]+/netConnections/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:setIamPolicy", - "request": { - "$ref": "GoogleIamV1SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/netConnections/{netConnectionsId}:testIamPermissions", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.netConnections.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/[^/]+/netConnections/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "operations": { "methods": { "cancel": { @@ -4347,7 +4129,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mutable fields include: display_name, gateway_regions.", + "description": "Required. Mutable fields include: display_name, hubs.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4392,6 +4174,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setPeering": { + "description": "This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:setPeering", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.securityGateways.setPeering", + "parameterOrder": [ + "securityGateway" + ], + "parameters": { + "securityGateway": { + "description": "Required. BeyondCorp SecurityGateway name using the form: `projects/{project}/locations/{location}/securityGateways/{security_gateway}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+securityGateway}:setPeering", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSetPeeringRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:testIamPermissions", @@ -4484,6 +4294,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": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:getIamPolicy", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.applications.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/[^/]+/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists Applications in a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", @@ -4494,7 +4335,7 @@ ], "parameters": { "filter": { - "description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160.", + "description": "Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160.", "location": "query", "type": "string" }, @@ -4510,7 +4351,7 @@ "type": "integer" }, "pageToken": { - "description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", + "description": "Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any.", "location": "query", "type": "string" }, @@ -4529,112 +4370,30 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "hubs": { - "methods": { - "delete": { - "description": "Deletes a single Hub.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", - "httpMethod": "DELETE", - "id": "beyondcorp.projects.locations.securityGateways.hubs.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Name of the resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "validateOnly": { - "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", - "location": "query", - "type": "boolean" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] }, - "get": { - "description": "Gets details of a single Hub.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", - "httpMethod": "GET", - "id": "beyondcorp.projects.locations.securityGateways.hubs.get", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}:setIamPolicy", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.securityGateways.applications.setIamPolicy", "parameterOrder": [ - "name" + "resource" ], "parameters": { - "name": { - "description": "Required. The resource name of the Hub using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/hubs/{hub_id}`", + "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/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists Hubs in a given project and location.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs", - "httpMethod": "GET", - "id": "beyondcorp.projects.locations.securityGateways.hubs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-hub\" For more information, please refer to https://google.aip.dev/160.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", - "required": true, - "type": "string" - } + "path": "v1alpha/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" }, - "path": "v1alpha/{+parent}/hubs", "response": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse" + "$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -4649,7 +4408,7 @@ } } }, - "revision": "20240807", + "revision": "20240925", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -6823,77 +6582,53 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication": { - "description": "A Beyondcorp Application resource information.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication", + "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata", "properties": { - "applicationMatchFilter": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", - "description": "Required. Application filter conditions associated with an application." + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" }, "createTime": { - "description": "Output only. Timestamp when the resource was created.", + "description": "Output only. The time the operation was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "displayName": { - "description": "Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.", + "endTime": { + "description": "Output only. The time the operation finished running.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "name": { - "description": "Identifier. Name of the resource.", - "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" }, - "updateTime": { - "description": "Output only. Timestamp when the resource was last modified.", - "format": "google-datetime", + "statusMessage": { + "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter": { - "description": "Match Criteria for Application Filtering.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", - "properties": { - "matchConditions": { - "description": "Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - (\"*.abc.com\"), (\"xyz.abc.com\") FQDN and PORTS - (\"abc.com\" and \"22\"), (\"abc.com\" and \"22,33)\" etc IP_ADDRESS - (\"10.20.30.40\"), (\"100.20.30.40\") IP_ADDRESS and PORTS - (\"10.20.30.40\" and \"4\"), (\"10.20.30.40\" and \"4,5\")", - "items": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition": { - "description": "Match condition for idenfying the application.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition", - "properties": { - "fqdn": { - "description": "Optional. FQDN of the application.", - "type": "string" }, - "ipAddress": { - "description": "Optional. IP Address of the application.", + "target": { + "description": "Output only. Server-defined resource path for the target of the operation.", + "readOnly": true, "type": "string" }, - "ports": { - "description": "Optional. Ports of the application.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" + "verb": { + "description": "Output only. Name of the verb executed by the operation.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub": { - "description": "A Beyondcorp Hub resource information.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub", + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication": { + "description": "A Beyondcorp Application resource information.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication", "properties": { "createTime": { "description": "Output only. Timestamp when the resource was created.", @@ -6902,40 +6637,20 @@ "type": "string" }, "displayName": { - "description": "Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.", + "description": "Optional. An arbitrary user-provided name for the Application resource. Cannot exceed 64 characters.", "type": "string" }, + "endpointMatchers": { + "description": "Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matcher is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one the conditions are met. The conditions can be one of the following combination (Hostname), (Hostname & Ports) EXAMPLES: Hostname - (\"*.abc.com\"), (\"xyz.abc.com\") Hostname and Ports - (\"abc.com\" and \"22\"), (\"abc.com\" and \"22,33\") etc", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher" + }, + "type": "array" + }, "name": { "description": "Identifier. Name of the resource.", "type": "string" }, - "natGatewayConfig": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", - "description": "Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits." - }, - "state": { - "description": "Output only. The operational state of the Hub.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "UPDATING", - "DELETING", - "RUNNING", - "DOWN", - "ERROR" - ], - "enumDescriptions": [ - "Default value. This value is unused.", - "Hub is being created.", - "Hub is being updated.", - "Hub is being deleted.", - "Hub is running.", - "Hub is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.", - "Hub encountered an error and is in an indeterministic state." - ], - "readOnly": true, - "type": "string" - }, "updateTime": { "description": "Output only. Timestamp when the resource was last modified.", "format": "google-datetime", @@ -6945,25 +6660,36 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig": { - "description": "Represents the NAT Gateway configuration.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher": { + "description": "EndpointMatcher contains the information of the endpoint that will match the application.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher", "properties": { - "enableNatGateway": { - "description": "Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.", - "type": "boolean" + "hostname": { + "description": "Required. Hostname of the application.", + "type": "string" }, - "natIps": { - "description": "Output only. List of NAT IPs that will be used for establishing connection to the endpoints.", + "ports": { + "description": "Optional. Ports of the application.", "items": { - "type": "string" + "format": "int32", + "type": "integer" }, - "readOnly": true, "type": "array" } }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub": { + "description": "The Hub message contains information pertaining to the regional data path deployments.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub", + "properties": { + "natGatewayConfig": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaNatGatewayConfig", + "description": "Optional. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits." + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse": { "description": "Message for response to listing Applications.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse", @@ -6989,21 +6715,21 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse": { - "description": "Message for response to listing Hubs.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse", + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse": { + "description": "Message for response to listing SecurityGateways.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse", "properties": { - "hubs": { - "description": "A list of BeyondCorp Hub in the project.", - "items": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" - }, - "type": "array" - }, "nextPageToken": { "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, + "securityGateways": { + "description": "A list of BeyondCorp SecurityGateway in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + }, + "type": "array" + }, "unreachable": { "description": "A list of locations that could not be reached.", "items": { @@ -7014,27 +6740,35 @@ }, "type": "object" }, - "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse": { - "description": "Message for response to listing SecurityGateways.", - "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse", + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaNatGatewayConfig": { + "description": "Represents the NAT Gateway configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaNatGatewayConfig", "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" - }, - "securityGateways": { - "description": "A list of BeyondCorp SecurityGateway in the project.", + "natIps": { + "description": "Output only. List of NAT IPs that will be used for establishing connection to the endpoints.", "items": { - "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway" + "type": "string" }, + "readOnly": true, "type": "array" - }, - "unreachable": { - "description": "A list of locations that could not be reached.", + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaPeering": { + "description": "VPC Peering details.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaPeering", + "properties": { + "dnsZones": { + "description": "Optional. List of DNS zones for DNS peering with the customer VPC network.", "items": { "type": "string" }, "type": "array" + }, + "targetVpcNetwork": { + "description": "Required. The name of the Target VPC network name in the format: `projects/{project}/global/networks/{network}", + "type": "string" } }, "type": "object" @@ -7061,6 +6795,13 @@ "readOnly": true, "type": "array" }, + "hubs": { + "additionalProperties": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" + }, + "description": "Optional. Map of Hubs that represents regional data path deployment with GCP region as a key.", + "type": "object" + }, "name": { "description": "Identifier. Name of the resource.", "type": "string" @@ -7141,6 +6882,28 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSetPeeringRequest": { + "description": "Set Peering request for creating a VPC peering between Google network and customer networks.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaSetPeeringRequest", + "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" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "type": "boolean" + }, + "vpcPeerings": { + "description": "Required. List of Peering connection information.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaPeering" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 9378890f46..abb6041154 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -39,6 +39,11 @@ "endpointUrl": "https://bigquery.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquery.europe-west9.rep.googleapis.com/", @@ -49,20 +54,65 @@ "endpointUrl": "https://bigquery.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquery.us-east4.rep.googleapis.com/", "location": "us-east4" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquery.us-east7.rep.googleapis.com/", "location": "us-east7" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquery.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquery.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1935,7 +1985,7 @@ } } }, - "revision": "20240815", + "revision": "20240919", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3269,12 +3319,12 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/environment\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"Production\". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details.", + "description": "Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example \"123456789012/environment\" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example \"Production\". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details.", "type": "object" }, "restrictions": { "$ref": "RestrictionConfig", - "description": "Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details.", + "description": "Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details.", "readOnly": true }, "satisfiesPzi": { @@ -4516,7 +4566,7 @@ "type": "object" }, "HparamTuningTrial": { - "description": "Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.", + "description": "Training info of a trial in [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models.", "id": "HparamTuningTrial", "properties": { "endTimeMs": { @@ -4614,6 +4664,7 @@ "NOT_SUPPORTED_IN_STANDARD_EDITION", "INDEX_SUPPRESSED_BY_FUNCTION_OPTION", "QUERY_CACHE_HIT", + "STALE_INDEX", "INTERNAL_ERROR", "OTHER_REASON" ], @@ -4636,6 +4687,7 @@ "Indicates that search indexes can not be used for search query with STANDARD edition.", "Indicates that an option in the search function that cannot make use of the index has been selected.", "Indicates that the query was cached, and thus the search index was not used.", + "The index cannot be used in the search query because it is stale.", "Indicates an internal error that causes the search index to be unused.", "Indicates that the reason search indexes cannot be used in the query is not covered by any of the other IndexUnusedReason options." ], @@ -4810,7 +4862,7 @@ }, "jobCreationReason": { "$ref": "JobCreationReason", - "description": "Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages)", + "description": "Output only. The reason why a Job was created. [Preview](https://cloud.google.com/products/#product-launch-stages)", "readOnly": true }, "jobReference": { @@ -5370,7 +5422,7 @@ "type": "object" }, "JobCreationReason": { - "description": "Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages)", + "description": "Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](https://cloud.google.com/products/#product-launch-stages)", "id": "JobCreationReason", "properties": { "code": { @@ -5854,7 +5906,7 @@ "readOnly": true }, "statementType": { - "description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement.", + "description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement.", "readOnly": true, "type": "string" }, @@ -6370,7 +6422,7 @@ "id": "MlStatistics", "properties": { "hparamTrials": { - "description": "Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.", + "description": "Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.", "items": { "$ref": "HparamTuningTrial" }, @@ -6378,7 +6430,7 @@ "type": "array" }, "iterationResults": { - "description": "Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).", + "description": "Results for all completed iterations. Empty for [hyperparameter tuning jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview).", "items": { "$ref": "IterationResult" }, @@ -6417,7 +6469,8 @@ "RANDOM_FOREST_CLASSIFIER", "TENSORFLOW_LITE", "ONNX", - "TRANSFORM_ONLY" + "TRANSFORM_ONLY", + "CONTRIBUTION_ANALYSIS" ], "enumDescriptions": [ "Default value.", @@ -6444,7 +6497,8 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions.", + "The contribution analysis model." ], "readOnly": true, "type": "string" @@ -6459,7 +6513,7 @@ "enumDescriptions": [ "Unspecified training type.", "Single training with fixed parameter space.", - "[Hyperparameter tuning training](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview)." + "[Hyperparameter tuning training](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview)." ], "readOnly": true, "type": "string" @@ -6483,7 +6537,7 @@ "type": "string" }, "defaultTrialId": { - "description": "Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.", + "description": "Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.", "format": "int64", "readOnly": true, "type": "string" @@ -6524,7 +6578,7 @@ "readOnly": true }, "hparamTrials": { - "description": "Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.", + "description": "Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.", "items": { "$ref": "HparamTuningTrial" }, @@ -6588,7 +6642,8 @@ "RANDOM_FOREST_CLASSIFIER", "TENSORFLOW_LITE", "ONNX", - "TRANSFORM_ONLY" + "TRANSFORM_ONLY", + "CONTRIBUTION_ANALYSIS" ], "enumDescriptions": [ "Default value.", @@ -6615,13 +6670,14 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions.", + "The contribution analysis model." ], "readOnly": true, "type": "string" }, "optimalTrialIds": { - "description": "Output only. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.", + "description": "Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.", "items": { "format": "int64", "type": "string" @@ -6688,7 +6744,7 @@ "id": "ModelExtractOptions", "properties": { "trialId": { - "description": "The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.", + "description": "The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning.", "format": "int64", "type": "string" } @@ -7109,7 +7165,7 @@ "description": "Optional. Output format adjustments." }, "jobCreationMode": { - "description": "Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](/products/#product-launch-stages)", + "description": "Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](https://cloud.google.com/products/#product-launch-stages)", "enum": [ "JOB_CREATION_MODE_UNSPECIFIED", "JOB_CREATION_REQUIRED", @@ -7216,7 +7272,7 @@ }, "jobCreationReason": { "$ref": "JobCreationReason", - "description": "Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](/products/#product-launch-stages)" + "description": "Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](https://cloud.google.com/products/#product-launch-stages)" }, "jobReference": { "$ref": "JobReference", @@ -7238,7 +7294,7 @@ "type": "string" }, "queryId": { - "description": "Auto-generated ID for the query. [Preview](/products/#product-launch-stages)", + "description": "Auto-generated ID for the query. [Preview](https://cloud.google.com/products/#product-launch-stages)", "type": "string" }, "rows": { @@ -7502,7 +7558,7 @@ ], "enumDescriptions": [ "Should never be used.", - "Restrict data egress. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details." + "Restrict data egress. See [Data egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details." ], "readOnly": true, "type": "string" @@ -8266,7 +8322,7 @@ "type": "string" }, "locationUri": { - "description": "Optional. The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/*'). The maximum length is 2056 bytes.", + "description": "Optional. The physical location of the table (e.g. `gs://spark-dataproc-data/pangea-data/case_sensitive/` or `gs://spark-dataproc-data/pangea-data/*`). The maximum length is 2056 bytes.", "type": "string" }, "outputFormat": { @@ -8565,7 +8621,7 @@ }, "restrictions": { "$ref": "RestrictionConfig", - "description": "Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details.", + "description": "Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See [Data egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details.", "readOnly": true }, "schema": { @@ -8604,7 +8660,7 @@ "description": "If specified, configures time-based partitioning for this table." }, "type": { - "description": "Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`.", + "description": "Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). The default value is `TABLE`.", "readOnly": true, "type": "string" }, @@ -9035,7 +9091,7 @@ "description": "Metadata caching eligible table referenced in the query." }, "tableType": { - "description": "[Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).", + "description": "[Table type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type).", "type": "string" }, "unusedReason": { @@ -9322,6 +9378,10 @@ "format": "double", "type": "number" }, + "contributionMetric": { + "description": "The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio contribution metrics. These include expressions such as \"SUM(x)\" or \"SUM(x)/SUM(y)\", where x and y are column names from the base table.", + "type": "string" + }, "dartNormalizeType": { "description": "Type of normalization algorithm for boosted tree models using dart booster.", "enum": [ @@ -9395,6 +9455,13 @@ "description": "If true, perform decompose time series and save the results.", "type": "boolean" }, + "dimensionIdColumns": { + "description": "Optional. Names of the columns to slice on. Applies to contribution analysis models.", + "items": { + "type": "string" + }, + "type": "array" + }, "distanceType": { "description": "Distance type for clustering models.", "enum": [ @@ -9818,6 +9885,10 @@ "format": "int64", "type": "string" }, + "isTestColumn": { + "description": "Name of the column used to determine the rows corresponding to control and test. Applies to contribution analysis models.", + "type": "string" + }, "itemColumn": { "description": "Item column specified for matrix factorization models.", "type": "string" @@ -9918,6 +9989,11 @@ "format": "int64", "type": "string" }, + "minAprioriSupport": { + "description": "The apriori support minimum. Applies to contribution analysis models.", + "format": "double", + "type": "number" + }, "minRelativeProgress": { "description": "When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.", "format": "double", diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 998fd12034..b0e4c9feb0 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -27,6 +27,11 @@ "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west9.rep.googleapis.com/", @@ -37,20 +42,65 @@ "endpointUrl": "https://bigquerydatatransfer.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east4.rep.googleapis.com/", "location": "us-east4" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east7.rep.googleapis.com/", "location": "us-east7" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigquerydatatransfer.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1407,7 +1457,7 @@ } } }, - "revision": "20240806", + "revision": "20240922", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { @@ -1691,6 +1741,17 @@ }, "type": "object" }, + "EventDrivenSchedule": { + "description": "Options customizing EventDriven transfers schedule.", + "id": "EventDrivenSchedule", + "properties": { + "pubsubSubscription": { + "description": "Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}", + "type": "string" + } + }, + "type": "object" + }, "ListDataSourcesResponse": { "description": "Returns list of supported data sources and their metadata.", "id": "ListDataSourcesResponse", @@ -1822,6 +1883,12 @@ }, "type": "object" }, + "ManualSchedule": { + "description": "Options customizing manual transfers schedule.", + "id": "ManualSchedule", + "properties": {}, + "type": "object" + }, "ScheduleOptions": { "description": "Options customizing the data transfer schedule.", "id": "ScheduleOptions", @@ -1843,6 +1910,25 @@ }, "type": "object" }, + "ScheduleOptionsV2": { + "description": "V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.", + "id": "ScheduleOptionsV2", + "properties": { + "eventDrivenSchedule": { + "$ref": "EventDrivenSchedule", + "description": "Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial." + }, + "manualSchedule": { + "$ref": "ManualSchedule", + "description": "Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true." + }, + "timeBasedSchedule": { + "$ref": "TimeBasedSchedule", + "description": "Time based transfer schedule options. This is the default schedule option." + } + }, + "type": "object" + }, "ScheduleTransferRunsRequest": { "description": "A request to schedule transfer runs for a time range.", "id": "ScheduleTransferRunsRequest", @@ -1931,6 +2017,27 @@ }, "type": "object" }, + "TimeBasedSchedule": { + "description": "Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.", + "id": "TimeBasedSchedule", + "properties": { + "endTime": { + "description": "Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment.", + "format": "google-datetime", + "type": "string" + }, + "schedule": { + "description": "Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.", + "type": "string" + }, + "startTime": { + "description": "Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "TimeRange": { "description": "A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).", "id": "TimeRange", @@ -1986,6 +2093,11 @@ "$ref": "EncryptionConfiguration", "description": "The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent." }, + "error": { + "$ref": "Status", + "description": "Output only. Error code with detailed information about reason of the latest config failure.", + "readOnly": true + }, "name": { "description": "Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.", "type": "string" @@ -2021,6 +2133,10 @@ "$ref": "ScheduleOptions", "description": "Options customizing the data transfer schedule." }, + "scheduleOptionsV2": { + "$ref": "ScheduleOptionsV2", + "description": "Options customizing different types of data transfer schedule. This field replaces \"schedule\" and \"schedule_options\" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule." + }, "state": { "description": "Output only. State of the most recently updated transfer run.", "enum": [ diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index 987e19a268..9f4708c8b3 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -24,6 +24,11 @@ "endpointUrl": "https://bigqueryreservation.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.europe-west9.rep.googleapis.com/", @@ -34,20 +39,65 @@ "endpointUrl": "https://bigqueryreservation.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-east4.rep.googleapis.com/", "location": "us-east4" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-east7.rep.googleapis.com/", "location": "us-east7" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://bigqueryreservation.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -885,7 +935,7 @@ } } }, - "revision": "20240611", + "revision": "20240921", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { @@ -991,13 +1041,13 @@ "id": "CapacityCommitment", "properties": { "commitmentEndTime": { - "description": "Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.", + "description": "Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time ,", "format": "google-datetime", "readOnly": true, "type": "string" }, "commitmentStartTime": { - "description": "Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.", + "description": "Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment.", "format": "google-datetime", "readOnly": true, "type": "string" diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index b20ee0816f..1907f6ab8d 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -2194,7 +2194,7 @@ } } }, - "revision": "20240824", + "revision": "20240918", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2375,6 +2375,20 @@ "description": "A backup of a Cloud Bigtable table.", "id": "Backup", "properties": { + "backupType": { + "description": "Indicates the backup type of the backup.", + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "STANDARD", + "HOT" + ], + "enumDescriptions": [ + "Not specified.", + "The default type for Cloud Bigtable managed backups. Supported for backups created in both HDD and SSD instances. Requires optimization when restored to a table in an SSD instance.", + "A backup type with faster restore to SSD performance. Only supported for backups created in SSD instances. A new SSD table restored from a hot backup reaches production performance more quickly than a standard backup." + ], + "type": "string" + }, "encryptionInfo": { "$ref": "EncryptionInfo", "description": "Output only. The encryption information for the backup.", @@ -2391,6 +2405,11 @@ "format": "google-datetime", "type": "string" }, + "hotToStandardTime": { + "description": "The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.", "type": "string" @@ -2566,6 +2585,20 @@ "description": "The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`.", "type": "string" }, + "nodeScalingFactor": { + "description": "Immutable. The node scaling factor of this cluster.", + "enum": [ + "NODE_SCALING_FACTOR_UNSPECIFIED", + "NODE_SCALING_FACTOR_1X", + "NODE_SCALING_FACTOR_2X" + ], + "enumDescriptions": [ + "No node scaling specified. Defaults to NODE_SCALING_FACTOR_1X.", + "The cluster is running with a scaling factor of 1.", + "The cluster is running with a scaling factor of 2. All node count values must be in increments of 2 with this scaling factor enabled, otherwise an INVALID_ARGUMENT error will be returned." + ], + "type": "string" + }, "serveNodes": { "description": "The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.", "format": "int32", @@ -3287,6 +3320,7 @@ "properties": { "bytesType": { "$ref": "GoogleBigtableAdminV2TypeBytes", + "deprecated": true, "description": "Deprecated: ignored if set." } }, @@ -3328,6 +3362,7 @@ }, "utf8Raw": { "$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", + "deprecated": true, "description": "Deprecated: if set, converts to an empty `utf8_bytes`." } }, @@ -3340,6 +3375,7 @@ "type": "object" }, "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw": { + "deprecated": true, "description": "Deprecated: prefer the equivalent `Utf8Bytes`.", "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", "properties": {}, @@ -3775,6 +3811,10 @@ "type": "string" }, "type": "array" + }, + "rowAffinity": { + "$ref": "RowAffinity", + "description": "Row affinity sticky routing based on the row key of the request. Requests that span multiple rows are routed non-deterministically." } }, "type": "object" @@ -4007,6 +4047,12 @@ }, "type": "object" }, + "RowAffinity": { + "description": "If enabled, Bigtable will route the request based on the row key of the request, rather than randomly. Instead, each row key will be assigned to a cluster, and will stick to that cluster. If clusters are added or removed, then this may affect which row keys stick to which clusters. To avoid this, users can use a cluster group to specify which clusters are to be used. In this case, new clusters that are not a part of the cluster group will not be routed to, and routing will be unaffected by the new cluster. Moreover, clusters specified in the cluster group cannot be deleted unless removed from the cluster group.", + "id": "RowAffinity", + "properties": {}, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", diff --git a/discovery/businessprofileperformance-v1.json b/discovery/businessprofileperformance-v1.json index fcf32f446e..0e66bace4c 100644 --- a/discovery/businessprofileperformance-v1.json +++ b/discovery/businessprofileperformance-v1.json @@ -294,25 +294,25 @@ "type": "string" }, "dailySubEntityType.timeOfDay.hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "location": "query", "type": "integer" }, "dailySubEntityType.timeOfDay.seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "location": "query", "type": "integer" @@ -417,7 +417,7 @@ } } }, - "revision": "20230620", + "revision": "20241002", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { @@ -635,22 +635,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/calendar-v3.json b/discovery/calendar-v3.json index e2347a96bf..5b4b20d757 100644 --- a/discovery/calendar-v3.json +++ b/discovery/calendar-v3.json @@ -1090,6 +1090,7 @@ "eventTypes": { "description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "enum": [ + "birthday", "default", "focusTime", "fromGmail", @@ -1097,6 +1098,7 @@ "workingLocation" ], "enumDescriptions": [ + "Special all-day events with an annual recurrence.", "Regular events.", "Focus time events.", "Events from Gmail.", @@ -1219,7 +1221,7 @@ "supportsSubscription": true }, "move": { - "description": "Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; outOfOffice, focusTime, workingLocation and fromGmail events cannot be moved.", + "description": "Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved.", "httpMethod": "POST", "id": "calendar.events.move", "parameterOrder": [ @@ -1507,6 +1509,7 @@ "eventTypes": { "description": "Event types to return. Optional. This parameter can be repeated multiple times to return events of different types. If unset, returns all event types.", "enum": [ + "birthday", "default", "focusTime", "fromGmail", @@ -1514,6 +1517,7 @@ "workingLocation" ], "enumDescriptions": [ + "Special all-day events with an annual recurrence.", "Regular events.", "Focus time events.", "Events from Gmail.", @@ -1763,7 +1767,7 @@ } } }, - "revision": "20240705", + "revision": "20240927", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2420,7 +2424,7 @@ }, "eventType": { "default": "default", - "description": "Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"default\" - A regular event or not further specified. \n- \"outOfOffice\" - An out-of-office event. \n- \"focusTime\" - A focus-time event. \n- \"workingLocation\" - A working location event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created.", + "description": "Specific type of the event. This cannot be modified after the event is created. Possible values are: \n- \"birthday\" - A special all-day event with an annual recurrence. \n- \"default\" - A regular event or not further specified. \n- \"focusTime\" - A focus-time event. \n- \"fromGmail\" - An event from Gmail. This type of event cannot be created. \n- \"outOfOffice\" - An out-of-office event. \n- \"workingLocation\" - A working location event.", "type": "string" }, "extendedProperties": { @@ -2733,7 +2737,7 @@ "type": "boolean" }, "responseStatus": { - "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation (recommended for new events). \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the \"Add invitations to my calendar\" setting set to \"When I respond to invitation in email\" won't see an event on their calendar unless they choose to change their invitation response in the event invitation email.", + "description": "The attendee's response status. Possible values are: \n- \"needsAction\" - The attendee has not responded to the invitation (recommended for new events). \n- \"declined\" - The attendee has declined the invitation. \n- \"tentative\" - The attendee has tentatively accepted the invitation. \n- \"accepted\" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the \"Add invitations to my calendar\" setting set to \"When I respond to invitation in email\" or \"Only if the sender is known\" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests.", "type": "string" }, "self": { diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 7e79ce8485..6ec5d561a7 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -17,6 +17,18 @@ "https://www.googleapis.com/auth/chat.admin.spaces.readonly": { "description": "View display name, description, and other metadata for all Google Chat conversations owned by your organization" }, + "https://www.googleapis.com/auth/chat.app.delete": { + "description": "On their own behalf, apps in Google Chat can delete conversations and spaces and remove access to associated files" + }, + "https://www.googleapis.com/auth/chat.app.memberships": { + "description": "On their own behalf, apps in Google Chat can see, add, update, and remove members from conversations and spaces" + }, + "https://www.googleapis.com/auth/chat.app.spaces": { + "description": "On their own behalf, apps in Google Chat can create conversations and spaces and see or update their metadata (including history settings and access settings)" + }, + "https://www.googleapis.com/auth/chat.app.spaces.create": { + "description": "On their own behalf, apps in Google Chat can create conversations and spaces" + }, "https://www.googleapis.com/auth/chat.bot": { "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, @@ -278,7 +290,7 @@ ] }, "create": { - "description": "Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Creates a space with no members. Can be used to create a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. If you're a member of the [Developer Preview program](https://developers.google.com/workspace/preview), you can create a group chat in import mode using `spaceType.GROUP_CHAT`. 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) When authenticating as an app, the `space.customer` field must be set in the request.", "flatPath": "v1/spaces", "httpMethod": "POST", "id": "chat.spaces.create", @@ -298,13 +310,15 @@ "$ref": "Space" }, "scopes": [ + "https://www.googleapis.com/auth/chat.app.spaces", + "https://www.googleapis.com/auth/chat.app.spaces.create", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.create" ] }, "delete": { - "description": "Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space.", + "description": "Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [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)", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "DELETE", "id": "chat.spaces.delete", @@ -320,7 +334,7 @@ "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", "location": "query", "type": "boolean" } @@ -331,12 +345,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.delete", + "https://www.googleapis.com/auth/chat.app.delete", "https://www.googleapis.com/auth/chat.delete", "https://www.googleapis.com/auth/chat.import" ] }, "findDirectMessage": { - "description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).", + "description": "Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. // Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", "flatPath": "v1/spaces:findDirectMessage", "httpMethod": "GET", "id": "chat.spaces.findDirectMessage", @@ -359,7 +374,7 @@ ] }, "get": { - "description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "GET", "id": "chat.spaces.get", @@ -375,7 +390,7 @@ "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", "location": "query", "type": "boolean" } @@ -387,13 +402,14 @@ "scopes": [ "https://www.googleapis.com/auth/chat.admin.spaces", "https://www.googleapis.com/auth/chat.admin.spaces.readonly", + "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.bot", "https://www.googleapis.com/auth/chat.spaces", "https://www.googleapis.com/auth/chat.spaces.readonly" ] }, "list": { - "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.", + "description": "Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead.", "flatPath": "v1/spaces", "httpMethod": "GET", "id": "chat.spaces.list", @@ -427,7 +443,7 @@ ] }, "patch": { - "description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. 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)", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "PATCH", "id": "chat.spaces.patch", @@ -443,13 +459,13 @@ "type": "string" }, "updateMask": { - "description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", + "description": "- Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", "format": "google-fieldmask", "location": "query", "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`.", "location": "query", "type": "boolean" } @@ -463,12 +479,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.spaces", + "https://www.googleapis.com/auth/chat.app.spaces", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.spaces" ] }, "search": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). Returns a list of spaces based on a user's search. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). The user must be an administrator for the Google Workspace organization. In the request, set `use_admin_access` to `true`.", + "description": "Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges). In the request, set `use_admin_access` to `true`.", "flatPath": "v1/spaces:search", "httpMethod": "GET", "id": "chat.spaces.search", @@ -534,7 +551,7 @@ "members": { "methods": { "create": { - "description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).", + "description": "Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. 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) For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api).", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "POST", "id": "chat.spaces.members.create", @@ -550,7 +567,7 @@ "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access.", "location": "query", "type": "boolean" } @@ -564,13 +581,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.memberships", + "https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.app" ] }, "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). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "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)", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "DELETE", "id": "chat.spaces.members.delete", @@ -586,7 +604,7 @@ "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access.", "location": "query", "type": "boolean" } @@ -597,13 +615,14 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.memberships", + "https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.app" ] }, "get": { - "description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-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) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "GET", "id": "chat.spaces.members.get", @@ -612,14 +631,14 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the user's 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.", + "description": "Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space}/members/app`. Format: `spaces/{space}/members/{member}` or `spaces/{space}/members/app` You can use the user's 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.", "location": "path", "pattern": "^spaces/[^/]+/members/[^/]+$", "required": true, "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access.", "location": "query", "type": "boolean" } @@ -637,7 +656,7 @@ ] }, "list": { - "description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. 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) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)", "flatPath": "v1/spaces/{spacesId}/members", "httpMethod": "GET", "id": "chat.spaces.members.list", @@ -646,7 +665,7 @@ ], "parameters": { "filter": { - "description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer Preview: You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", + "description": "Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = \"HUMAN\"` or `member.type != \"BOT\"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = \"ROLE_MANAGER\" OR role = \"ROLE_MEMBER\" member.type = \"HUMAN\" AND role = \"ROLE_MANAGER\" member.type != \"BOT\" ``` The following queries are invalid: ``` member.type = \"HUMAN\" AND member.type = \"BOT\" role = \"ROLE_MANAGER\" AND role = \"ROLE_MEMBER\" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error.", "location": "query", "type": "string" }, @@ -679,7 +698,7 @@ "type": "boolean" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access.", "location": "query", "type": "boolean" } @@ -698,7 +717,7 @@ ] }, "patch": { - "description": "Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", + "description": "Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-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)", "flatPath": "v1/spaces/{spacesId}/members/{membersId}", "httpMethod": "PATCH", "id": "chat.spaces.members.patch", @@ -720,7 +739,7 @@ "type": "string" }, "useAdminAccess": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", + "description": "When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes).", "location": "query", "type": "boolean" } @@ -734,6 +753,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.admin.memberships", + "https://www.googleapis.com/auth/chat.app.memberships", "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships" ] @@ -805,7 +825,7 @@ ] }, "delete": { - "description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only delete messages created by the calling Chat app.", + "description": "Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only delete messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "DELETE", "id": "chat.spaces.messages.delete", @@ -837,7 +857,7 @@ ] }, "get": { - "description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Note: Might return a message from a blocked member or space.", + "description": "Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Note: Might return a message from a blocked member or space.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "GET", "id": "chat.spaces.messages.get", @@ -917,7 +937,7 @@ ] }, "patch": { - "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app.", + "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "PATCH", "id": "chat.spaces.messages.patch", @@ -958,7 +978,7 @@ ] }, "update": { - "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app.", + "description": "Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app.", "flatPath": "v1/spaces/{spacesId}/messages/{messagesId}", "httpMethod": "PUT", "id": "chat.spaces.messages.update", @@ -1324,7 +1344,7 @@ } } }, - "revision": "20240825", + "revision": "20241001", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1341,13 +1361,13 @@ "enumDescriptions": [ "Access state is unknown or not supported in this API.", "Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.", - "A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience)." + "A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). Creating discoverable spaces requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)." ], "readOnly": true, "type": "string" }, "audience": { - "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", + "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope in [Developer Preview](https://developers.google.com/workspace/preview). This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "type": "string" } }, @@ -1736,6 +1756,25 @@ }, "type": "object" }, + "ChatSpaceLinkData": { + "description": "Data for Chat space links.", + "id": "ChatSpaceLinkData", + "properties": { + "message": { + "description": "The message of the linked Chat space resource. Format: `spaces/{space}/messages/{message}`", + "type": "string" + }, + "space": { + "description": "The space of the linked Chat space resource. Format: `spaces/{space}`", + "type": "string" + }, + "thread": { + "description": "The thread of the linked Chat space resource. Format: `spaces/{space}/threads/{thread}`", + "type": "string" + } + }, + "type": "object" + }, "Color": { "description": "Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ...", "id": "Color", @@ -1800,7 +1839,7 @@ "The add-on launches from Google Sheets.", "The add-on launches from Google Slides.", "The add-on launches from Google Drawings.", - "A Google Chat app." + "A Google Chat app. Not used for Google Workspace Add-ons." ], "type": "string" }, @@ -2302,7 +2341,7 @@ "description": "When displaying contextual content, the peek card header acts as a placeholder so that the user can navigate forward between the homepage cards and the contextual cards. [Google Workspace Add-ons](https://developers.google.com/workspace/add-ons):" }, "sectionDividerStyle": { - "description": "The divider style between sections.", + "description": "The divider style between the header, sections and footer.", "enum": [ "DIVIDER_STYLE_UNSPECIFIED", "SOLID_DIVIDER", @@ -2451,7 +2490,7 @@ "type": "object" }, "GoogleAppsCardV1Columns": { - "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", + "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event.", "id": "GoogleAppsCardV1Columns", "properties": { "columnItems": { @@ -3568,7 +3607,7 @@ }, "groupMember": { "$ref": "Group", - "description": "The Google Group the membership corresponds to." + "description": "The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user)." }, "member": { "$ref": "User", @@ -3655,7 +3694,7 @@ "type": "object" }, "MembershipCount": { - "description": "[Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories.", + "description": "Represents the count of memberships of a space, grouped into categories.", "id": "MembershipCount", "properties": { "joinedDirectHumanUserCount": { @@ -3816,7 +3855,7 @@ }, "privateMessageViewer": { "$ref": "User", - "description": "Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) to send a message, the message can't be private and must omit this field. For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private)." + "description": "Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and omit the following: * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) * [Accessory widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private)." }, "quotedMessageMetadata": { "$ref": "QuotedMessageMetadata", @@ -3954,6 +3993,61 @@ }, "type": "object" }, + "PermissionSetting": { + "description": "Represents a space permission setting.", + "id": "PermissionSetting", + "properties": { + "managersAllowed": { + "description": "Whether spaces managers have this permission.", + "type": "boolean" + }, + "membersAllowed": { + "description": "Whether non-manager members have this permission.", + "type": "boolean" + } + }, + "type": "object" + }, + "PermissionSettings": { + "description": "[Permission settings](https://support.google.com/chat/answer/13340792) for a named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request.", + "id": "PermissionSettings", + "properties": { + "manageApps": { + "$ref": "PermissionSetting", + "description": "Setting for managing apps in a space." + }, + "manageMembersAndGroups": { + "$ref": "PermissionSetting", + "description": "Setting for managing members and groups in a space." + }, + "manageWebhooks": { + "$ref": "PermissionSetting", + "description": "Setting for managing webhooks in a space." + }, + "modifySpaceDetails": { + "$ref": "PermissionSetting", + "description": "Setting for updating space name, avatar, description and guidelines." + }, + "postMessages": { + "$ref": "PermissionSetting", + "description": "Output only. Setting for posting messages in a space.", + "readOnly": true + }, + "replyMessages": { + "$ref": "PermissionSetting", + "description": "Setting for replying to messages in a space." + }, + "toggleHistory": { + "$ref": "PermissionSetting", + "description": "Setting for toggling space history on and off." + }, + "useAtMentionAll": { + "$ref": "PermissionSetting", + "description": "Setting for using @all in a space." + } + }, + "type": "object" + }, "QuotedMessageMetadata": { "description": "Information about a quoted message.", "id": "QuotedMessageMetadata", @@ -4046,6 +4140,10 @@ "description": "A rich link to a resource.", "id": "RichLinkMetadata", "properties": { + "chatSpaceLinkData": { + "$ref": "ChatSpaceLinkData", + "description": "Data for a chat space link." + }, "driveLinkData": { "$ref": "DriveLinkData", "description": "Data for a drive link." @@ -4054,11 +4152,13 @@ "description": "The rich link type.", "enum": [ "RICH_LINK_TYPE_UNSPECIFIED", - "DRIVE_FILE" + "DRIVE_FILE", + "CHAT_SPACE" ], "enumDescriptions": [ "Default value for the enum. Don't use.", - "A Google Drive rich link type." + "A Google Drive rich link type.", + "A Chat space rich link type. For example, a space smart chip." ], "type": "string" }, @@ -4215,7 +4315,7 @@ "type": "string" }, "displayName": { - "description": "The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.", + "description": "The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters.", "type": "string" }, "externalUserAllowed": { @@ -4223,24 +4323,42 @@ "type": "boolean" }, "importMode": { - "description": "Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.", + "description": "Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).", "type": "boolean" }, "lastActiveTime": { - "description": "Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview).", + "description": "Output only. Timestamp of the last message in the space.", "format": "google-datetime", "readOnly": true, "type": "string" }, "membershipCount": { "$ref": "MembershipCount", - "description": "Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview).", + "description": "Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`.", "readOnly": true }, "name": { "description": "Resource name of the space. Format: `spaces/{space}` Where `{space}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`.", "type": "string" }, + "permissionSettings": { + "$ref": "PermissionSettings", + "description": "Optional. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, use `predefined_permission_settings` instead." + }, + "predefinedPermissionSettings": { + "description": "Optional. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the `PermissionSettings` field.", + "enum": [ + "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED", + "COLLABORATION_SPACE", + "ANNOUNCEMENT_SPACE" + ], + "enumDescriptions": [ + "Unspecified. Don't use.", + "Setting to make the space a collaboration space where all members can post messages.", + "Setting to make the space an announcement space where only space managers can post messages." + ], + "type": "string" + }, "singleUserBotDm": { "description": "Optional. Whether the space is a DM between a Chat app and a single human.", "type": "boolean" diff --git a/discovery/checks-v1alpha.json b/discovery/checks-v1alpha.json index 31ab3bf79d..5bd5ec6998 100644 --- a/discovery/checks-v1alpha.json +++ b/discovery/checks-v1alpha.json @@ -368,6 +368,36 @@ } } } + }, + "repos": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1alpha/accounts/{accountsId}/repos/{reposId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "checks.accounts.repos.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^accounts/[^/]+/repos/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Operation" + } + } + } + } + } } } }, @@ -414,7 +444,7 @@ } } }, - "revision": "20240627", + "revision": "20240904", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 5457b56b06..be8613eed7 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -9,7 +9,7 @@ "description": "See reports about devices and Chrome browsers managed within your organization" }, "https://www.googleapis.com/auth/chrome.management.telemetry.readonly": { - "description": "See basic device and telemetry information collected from Chrome OS devices or users managed within your organization" + "description": "See basic device and telemetry information collected from ChromeOS devices or users managed within your organization" } } } @@ -1172,7 +1172,7 @@ } } }, - "revision": "20240815", + "revision": "20241003", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -3682,7 +3682,8 @@ "APPLICATION_LAUNCH_SOURCE_FIRST_RUN", "APPLICATION_LAUNCH_SOURCE_WELCOME_TOUR", "APPLICATION_LAUNCH_SOURCE_FOCUS_MODE", - "APPLICATION_LAUNCH_SOURCE_SPARKY" + "APPLICATION_LAUNCH_SOURCE_SPARKY", + "APPLICATION_LAUNCH_SOURCE_NAVIGATION_CAPTURING" ], "enumDescriptions": [ "Application launch source unknown.", @@ -3726,7 +3727,8 @@ "Count first-run Help app launches separately so that we can understand the number of user-triggered launches.", "Application launched from welcome tour.", "Applicationed launched from focus panel.", - "Application launched from experimental feature Sparky." + "Application launched from experimental feature Sparky.", + "Application launched from navigation capturing." ], "type": "string" }, diff --git a/discovery/chromepolicy-v1.json b/discovery/chromepolicy-v1.json index 98cfcd105d..a10d376f06 100644 --- a/discovery/chromepolicy-v1.json +++ b/discovery/chromepolicy-v1.json @@ -3,10 +3,10 @@ "oauth2": { "scopes": { "https://www.googleapis.com/auth/chrome.management.policy": { - "description": "See, edit, create or delete policies applied to Chrome OS and Chrome Browsers managed within your organization" + "description": "See, edit, create or delete policies applied to ChromeOS and Chrome Browsers managed within your organization" }, "https://www.googleapis.com/auth/chrome.management.policy.readonly": { - "description": "See policies applied to Chrome OS and Chrome Browsers managed within your organization" + "description": "See policies applied to ChromeOS and Chrome Browsers managed within your organization" } } } @@ -557,7 +557,7 @@ } } }, - "revision": "20240729", + "revision": "20241004", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { diff --git a/discovery/chromeuxreport-v1.json b/discovery/chromeuxreport-v1.json index 75ad4a4024..93fcf43fbe 100644 --- a/discovery/chromeuxreport-v1.json +++ b/discovery/chromeuxreport-v1.json @@ -131,7 +131,7 @@ } } }, - "revision": "20240103", + "revision": "20240916", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { @@ -140,8 +140,7 @@ "properties": { "density": { "description": "The proportion of users that experienced this bin's value for the given metric.", - "format": "double", - "type": "number" + "type": "any" }, "end": { "description": "End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf.", diff --git a/discovery/civicinfo-v2.json b/discovery/civicinfo-v2.json index 4f86f096e4..651fcd9b37 100644 --- a/discovery/civicinfo-v2.json +++ b/discovery/civicinfo-v2.json @@ -97,6 +97,23 @@ "resources": { "divisions": { "methods": { + "queryDivisionByAddress": { + "description": "Lookup OCDIDs and names for divisions related to an address.", + "flatPath": "civicinfo/v2/divisionsByAddress", + "httpMethod": "GET", + "id": "civicinfo.divisions.queryDivisionByAddress", + "parameterOrder": [], + "parameters": { + "address": { + "location": "query", + "type": "string" + } + }, + "path": "civicinfo/v2/divisionsByAddress", + "response": { + "$ref": "DivisionByAddressResponse" + } + }, "search": { "description": "Searches for political divisions by their natural name or OCD ID.", "flatPath": "civicinfo/v2/divisions", @@ -362,7 +379,7 @@ } } }, - "revision": "20240620", + "revision": "20240910", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { @@ -696,6 +713,22 @@ }, "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", diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 11cdbe40fb..319e2e8829 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -575,14 +575,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -751,14 +751,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -795,14 +795,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -836,14 +836,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -870,7 +870,7 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" @@ -888,7 +888,7 @@ }, "postId": { "deprecated": true, - "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.", + "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1072,14 +1072,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1250,14 +1250,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1294,14 +1294,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1335,14 +1335,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1369,7 +1369,7 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" @@ -1387,7 +1387,7 @@ }, "postId": { "deprecated": true, - "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.", + "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -1475,14 +1475,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, @@ -1526,14 +1526,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" }, @@ -2032,14 +2032,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -2184,14 +2184,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -2228,14 +2228,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -2269,14 +2269,14 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" }, "postId": { "deprecated": true, - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -2303,7 +2303,7 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "location": "path", "required": true, "type": "string" @@ -2321,7 +2321,7 @@ }, "postId": { "deprecated": true, - "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.", + "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "location": "query", "type": "string" } @@ -2413,12 +2413,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2455,12 +2455,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2498,12 +2498,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2538,12 +2538,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2571,7 +2571,7 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, @@ -2587,7 +2587,7 @@ "type": "string" }, "postId": { - "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead.", + "description": "Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2676,12 +2676,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -2726,12 +2726,12 @@ "type": "string" }, "itemId": { - "description": "Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", + "description": "Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.", "location": "query", "type": "string" }, "postId": { - "description": "Optional. Deprecated, use item_id instead.", + "description": "Optional. Deprecated, use `item_id` instead.", "location": "path", "required": true, "type": "string" @@ -3695,7 +3695,7 @@ } } }, - "revision": "20240713", + "revision": "20240911", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { @@ -3727,7 +3727,7 @@ "type": "string" }, "itemId": { - "description": "Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. Unique per course.", + "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. Unique per course.", "type": "string" }, "maxPoints": { @@ -3737,20 +3737,20 @@ }, "postId": { "deprecated": true, - "description": "Immutable. Deprecated, use item_id instead.", + "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" }, "studentViewUri": { "$ref": "EmbedUri", - "description": "Required. URI to show the student view of the attachment. The URI will be opened in an iframe with the `courseId`, `postId`, and `attachmentId` query parameters set." + "description": "Required. URI to show the student view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set." }, "studentWorkReviewUri": { "$ref": "EmbedUri", - "description": "URI for the teacher to see student work on the attachment, if applicable. The URI will be opened in an iframe with the `courseId`, `postId`, `attachmentId`, and `submissionId` query parameters set. This is the same `submissionId` returned by google.classroom.AddOns.GetAddOnContext when a student views the attachment. If the URI is omitted or removed, `max_points` will also be discarded." + "description": "URI for the teacher to see student work on the attachment, if applicable. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, `attachmentId`, and `submissionId` query parameters set. This is the same `submissionId` returned in the [`AddOnContext.studentContext`](//devsite.google.com/classroom/reference/rest/v1/AddOnContext#StudentContext) field when a student views the attachment. If the URI is omitted or removed, `max_points` will also be discarded." }, "teacherViewUri": { "$ref": "EmbedUri", - "description": "Required. URI to show the teacher view of the attachment. The URI will be opened in an iframe with the `courseId`, `postId`, and `attachmentId` query parameters set." + "description": "Required. URI to show the teacher view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set." }, "title": { "description": "Required. Title of this attachment. The title must be between 1 and 1000 characters.", @@ -3800,12 +3800,12 @@ "type": "string" }, "itemId": { - "description": "Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached.", + "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.", "type": "string" }, "postId": { "deprecated": true, - "description": "Immutable. Deprecated, use item_id instead.", + "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" }, "studentContext": { @@ -3978,12 +3978,12 @@ "type": "string" }, "itemId": { - "description": "Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached.", + "description": "Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.", "type": "string" }, "postId": { "deprecated": true, - "description": "Immutable. Deprecated, use item_id instead.", + "description": "Immutable. Deprecated, use `item_id` instead.", "type": "string" } }, diff --git a/discovery/cloudbilling-v1beta.json b/discovery/cloudbilling-v1beta.json index 422cbce80a..3b4e1054f0 100644 --- a/discovery/cloudbilling-v1beta.json +++ b/discovery/cloudbilling-v1beta.json @@ -761,7 +761,7 @@ } } }, - "revision": "20240531", + "revision": "20240906", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { @@ -961,7 +961,7 @@ "type": "object" }, "CloudStorageEgressWorkload": { - "description": "Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage.", + "description": "Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. * If transferring data between two regions, the source and destination fields are set to different values. For example: `source_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\", `destination_continent` = \"SOURCE_CONTINENT_SOUTH_AMERICA\". * If transferring data within one region, the source and destination fields are set to the same value. For example: `source_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\", `destination_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\". Some examples for the Network data transfer traffic type on the pricing page. * Data moves between different locations on the same continent. `source_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\", `destination_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\". * Data moves between different continents and neither is Australia. `source_continent` = \"SOURCE_CONTINENT_NORTH_AMERICA\", `destination_continent` = \"SOURCE_CONTINENT_ASIA_PACIFIC\". * Data moves between different continents and one is Australia. `source_continent` = \"SOURCE_CONTINENT_NORTH_AMERICA\", `destination_continent` = \"SOURCE_CONTINENT_AUSTRALIA\".", "id": "CloudStorageEgressWorkload", "properties": { "destinationContinent": { diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 6b7c178a45..46b1e8beb5 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2346,7 +2346,7 @@ } } }, - "revision": "20240704", + "revision": "20240923", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3017,11 +3017,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, @@ -3428,7 +3430,7 @@ "type": "string" }, "serviceAccount": { - "description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`", + "description": "The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}`", "type": "string" }, "sourceToBuild": { diff --git a/discovery/cloudchannel-v1.json b/discovery/cloudchannel-v1.json index ea0c4cea11..4502e083ed 100644 --- a/discovery/cloudchannel-v1.json +++ b/discovery/cloudchannel-v1.json @@ -154,11 +154,6 @@ "required": true, "type": "string" }, - "integrator": { - "description": "Optional. Resource name of the integrator.", - "location": "query", - "type": "string" - }, "pageSize": { "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", "format": "int32", @@ -1971,121 +1966,6 @@ } } }, - "integrators": { - "methods": { - "listSubscribers": { - "description": "Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", - "flatPath": "v1/integrators/{integratorsId}:listSubscribers", - "httpMethod": "GET", - "id": "cloudchannel.integrators.listSubscribers", - "parameterOrder": [ - "integrator" - ], - "parameters": { - "account": { - "description": "Optional. Resource name of the account.", - "location": "query", - "type": "string" - }, - "integrator": { - "description": "Optional. Resource name of the integrator.", - "location": "path", - "pattern": "^integrators/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+integrator}:listSubscribers", - "response": { - "$ref": "GoogleCloudChannelV1ListSubscribersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/apps.order" - ] - }, - "register": { - "description": "Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", - "flatPath": "v1/integrators/{integratorsId}:register", - "httpMethod": "POST", - "id": "cloudchannel.integrators.register", - "parameterOrder": [ - "integrator" - ], - "parameters": { - "account": { - "description": "Optional. Resource name of the account.", - "location": "query", - "type": "string" - }, - "integrator": { - "description": "Optional. Resource name of the integrator.", - "location": "path", - "pattern": "^integrators/[^/]+$", - "required": true, - "type": "string" - }, - "serviceAccount": { - "description": "Required. Service account that provides subscriber access to the registered topic.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+integrator}:register", - "response": { - "$ref": "GoogleCloudChannelV1RegisterSubscriberResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/apps.order" - ] - }, - "unregister": { - "description": "Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", - "flatPath": "v1/integrators/{integratorsId}:unregister", - "httpMethod": "POST", - "id": "cloudchannel.integrators.unregister", - "parameterOrder": [ - "integrator" - ], - "parameters": { - "account": { - "description": "Optional. Resource name of the account.", - "location": "query", - "type": "string" - }, - "integrator": { - "description": "Optional. Resource name of the integrator.", - "location": "path", - "pattern": "^integrators/[^/]+$", - "required": true, - "type": "string" - }, - "serviceAccount": { - "description": "Required. Service account to unregister from subscriber access to the topic.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+integrator}:unregister", - "response": { - "$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/apps.order" - ] - } - } - }, "operations": { "methods": { "cancel": { @@ -2303,7 +2183,7 @@ } } }, - "revision": "20240828", + "revision": "20240913", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2579,11 +2459,11 @@ "id": "GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest", "properties": { "domain": { - "description": "Required. Domain to fetch for Cloud Identity account customers, including domained and domainless.", + "description": "Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails.", "type": "string" }, "primaryAdminEmail": { - "description": "Optional. Primary admin email to fetch for Cloud Identity account domainless customer.", + "description": "Optional. Primary admin email to fetch for Cloud Identity account team customer.", "type": "string" } }, @@ -3450,7 +3330,7 @@ "type": "boolean" }, "primaryAdminEmail": { - "description": "Optional. Customer's primary admin email.", + "description": "Required. Customer's primary admin email.", "type": "string" } }, @@ -4363,10 +4243,6 @@ "description": "Request Message for RegisterSubscriber.", "id": "GoogleCloudChannelV1RegisterSubscriberRequest", "properties": { - "integrator": { - "description": "Optional. Resource name of the integrator.", - "type": "string" - }, "serviceAccount": { "description": "Required. Service account that provides subscriber access to the registered topic.", "type": "string" @@ -4941,10 +4817,6 @@ "description": "Request Message for UnregisterSubscriber.", "id": "GoogleCloudChannelV1UnregisterSubscriberRequest", "properties": { - "integrator": { - "description": "Optional. Resource name of the integrator.", - "type": "string" - }, "serviceAccount": { "description": "Required. Service account to unregister from subscriber access to the topic.", "type": "string" diff --git a/discovery/cloudcontrolspartner-v1.json b/discovery/cloudcontrolspartner-v1.json index 3e924ccd64..b8f67bcb8e 100644 --- a/discovery/cloudcontrolspartner-v1.json +++ b/discovery/cloudcontrolspartner-v1.json @@ -484,7 +484,7 @@ } } }, - "revision": "20240814", + "revision": "20240904", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -598,7 +598,7 @@ "readOnly": true }, "displayName": { - "description": "The customer organization's display name. E.g. \"Google\".", + "description": "Required. Display name for the customer", "type": "string" }, "isOnboarded": { diff --git a/discovery/cloudcontrolspartner-v1beta.json b/discovery/cloudcontrolspartner-v1beta.json index 3c6fd4d629..eaf354817f 100644 --- a/discovery/cloudcontrolspartner-v1beta.json +++ b/discovery/cloudcontrolspartner-v1beta.json @@ -484,7 +484,7 @@ } } }, - "revision": "20240814", + "revision": "20240904", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -598,7 +598,7 @@ "readOnly": true }, "displayName": { - "description": "The customer organization's display name. E.g. \"Google\".", + "description": "Required. Display name for the customer", "type": "string" }, "isOnboarded": { diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index cdede2b9ab..ada8a0ad99 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -1159,6 +1159,12 @@ "parent" ], "parameters": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "location": "query", + "repeated": true, + "type": "string" + }, "parent": { "description": "Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", @@ -1361,6 +1367,12 @@ "parent" ], "parameters": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "location": "query", + "repeated": true, + "type": "string" + }, "parent": { "description": "Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.", "location": "path", @@ -1638,6 +1650,218 @@ } } }, + "deployPolicies": { + "methods": { + "create": { + "description": "Creates a new DeployPolicy in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies", + "httpMethod": "POST", + "id": "clouddeploy.projects.locations.deployPolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "deployPolicyId": { + "description": "Required. ID of the `DeployPolicy`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id}/locations/{location_name}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 to true, the request is validated and the user is provided with an expected result, but no actual change is made.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/deployPolicies", + "request": { + "$ref": "DeployPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single DeployPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", + "httpMethod": "DELETE", + "id": "clouddeploy.projects.locations.deployPolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, then deleting an already deleted or non-existing `DeployPolicy` will succeed.", + "location": "query", + "type": "boolean" + }, + "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. The name of the `DeployPolicy` to delete. The format is `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 review, 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 DeployPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", + "httpMethod": "GET", + "id": "clouddeploy.projects.locations.deployPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the `DeployPolicy`. Format must be `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "DeployPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DeployPolicies in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies", + "httpMethod": "GET", + "id": "clouddeploy.projects.locations.deployPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDeployPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id}/locations/{location_name}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/deployPolicies", + "response": { + "$ref": "ListDeployPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single DeployPolicy.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deployPolicies/{deployPoliciesId}", + "httpMethod": "PATCH", + "id": "clouddeploy.projects.locations.deployPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If set to true, updating a `DeployPolicy` that does not exist will result in the creation of a new `DeployPolicy`.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. Name of the `DeployPolicy`. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deployPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 by the update in the `DeployPolicy` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "DeployPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -2065,7 +2289,7 @@ } } }, - "revision": "20240809", + "revision": "20240929", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -2135,6 +2359,13 @@ "description": "The request object used by `AdvanceRollout`.", "id": "AdvanceRolloutRequest", "properties": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" + }, "phaseId": { "description": "Required. The phase ID to advance the `Rollout` to.", "type": "string" @@ -2194,6 +2425,13 @@ "approved": { "description": "Required. True = approve; false = reject", "type": "boolean" + }, + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2348,6 +2586,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2358,6 +2597,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2368,6 +2608,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2488,6 +2729,11 @@ "readOnly": true, "type": "string" }, + "policyViolation": { + "$ref": "PolicyViolation", + "description": "Output only. Contains information about what policies prevented the `AutomationRun` from proceeding.", + "readOnly": true + }, "promoteReleaseOperation": { "$ref": "PromoteReleaseOperation", "description": "Output only. Promotes a release to a specified 'Target'.", @@ -2594,6 +2840,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2604,6 +2851,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2614,6 +2862,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2725,7 +2974,15 @@ "CancelRolloutRequest": { "description": "The request object used by `CancelRollout`.", "id": "CancelRolloutRequest", - "properties": {}, + "properties": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "CancelRolloutResponse": { @@ -3046,6 +3303,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3056,6 +3314,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3066,6 +3325,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3173,6 +3433,24 @@ }, "type": "object" }, + "DeliveryPipelineAttribute": { + "description": "Contains criteria for selecting DeliveryPipelines.", + "id": "DeliveryPipelineAttribute", + "properties": { + "id": { + "description": "ID of the `DeliveryPipeline`. The value of this field could be one of the following: * The last segment of a pipeline name * \"*\", all delivery pipelines in a location", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "DeliveryPipeline labels.", + "type": "object" + } + }, + "type": "object" + }, "DeliveryPipelineNotificationEvent": { "description": "Payload proto for \"clouddeploy.googleapis.com/deliverypipeline_notification\" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification.", "id": "DeliveryPipelineNotificationEvent", @@ -3199,6 +3477,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3209,6 +3488,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3219,6 +3499,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3339,8 +3620,169 @@ "additionalProperties": { "type": "string" }, - "description": "Required. Values are deploy parameters in key-value pairs.", - "type": "object" + "description": "Required. Values are deploy parameters in key-value pairs.", + "type": "object" + } + }, + "type": "object" + }, + "DeployPolicy": { + "description": "A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy` inhibits manual or automation-driven actions within a Delivery Pipeline or Target.", + "id": "DeployPolicy", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details.", + "type": "object" + }, + "createTime": { + "description": "Output only. Time at which the deploy policy was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Description of the `DeployPolicy`. Max length is 255 characters.", + "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.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the `DeployPolicy`. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`", + "readOnly": true, + "type": "string" + }, + "rules": { + "description": "Required. Rules to apply. At least one rule must be present.", + "items": { + "$ref": "PolicyRule" + }, + "type": "array" + }, + "selectors": { + "description": "Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action.", + "items": { + "$ref": "DeployPolicyResourceSelector" + }, + "type": "array" + }, + "suspended": { + "description": "When suspended, the policy will not prevent actions from occurring, even if the action violates the policy.", + "type": "boolean" + }, + "uid": { + "description": "Output only. Unique identifier of the `DeployPolicy`.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Most recent time at which the deploy policy was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DeployPolicyEvaluationEvent": { + "description": "Payload proto for \"clouddeploy.googleapis.com/deploypolicy_evaluation\" Platform Log event that describes the deploy policy evaluation event.", + "id": "DeployPolicyEvaluationEvent", + "properties": { + "allowed": { + "description": "Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended", + "type": "boolean" + }, + "deliveryPipeline": { + "description": "The name of the `Delivery Pipeline`.", + "type": "string" + }, + "deployPolicy": { + "description": "The name of the `DeployPolicy`.", + "type": "string" + }, + "deployPolicyUid": { + "description": "Unique identifier of the `DeployPolicy`.", + "type": "string" + }, + "invoker": { + "description": "What invoked the action (e.g. a user or automation).", + "enum": [ + "INVOKER_UNSPECIFIED", + "USER", + "DEPLOY_AUTOMATION" + ], + "enumDescriptions": [ + "Unspecified.", + "The action is user-driven. For example, creating a rollout manually via a gcloud create command.", + "Automated action by Cloud Deploy." + ], + "type": "string" + }, + "message": { + "description": "Debug message for when a deploy policy event occurs.", + "type": "string" + }, + "overrides": { + "description": "Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed.", + "items": { + "enum": [ + "POLICY_VERDICT_OVERRIDE_UNSPECIFIED", + "POLICY_OVERRIDDEN", + "POLICY_SUSPENDED" + ], + "enumDescriptions": [ + "This should never happen.", + "The policy was overridden.", + "The policy was suspended." + ], + "type": "string" + }, + "type": "array" + }, + "pipelineUid": { + "description": "Unique identifier of the `Delivery Pipeline`.", + "type": "string" + }, + "rule": { + "description": "Rule id.", + "type": "string" + }, + "ruleType": { + "description": "Rule type (e.g. Restrict Rollouts).", + "type": "string" + }, + "target": { + "description": "The name of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy.", + "type": "string" + }, + "targetUid": { + "description": "Unique identifier of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy.", + "type": "string" + }, + "verdict": { + "description": "The policy verdict of the request.", + "enum": [ + "POLICY_VERDICT_UNSPECIFIED", + "ALLOWED_BY_POLICY", + "DENIED_BY_POLICY" + ], + "enumDescriptions": [ + "This should never happen.", + "Allowed by policy. This enum value is not currently used but may be used in the future. Currently logs are only generated when a request is denied by policy.", + "Denied by policy." + ], + "type": "string" } }, "type": "object" @@ -3371,6 +3813,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3381,6 +3824,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3391,6 +3835,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3398,6 +3843,21 @@ }, "type": "object" }, + "DeployPolicyResourceSelector": { + "description": "Contains information on the resources to select for a deploy policy. Attributes provided must all match the resource in order for policy restrictions to apply. For example, if delivery pipelines attributes given are an id \"prod\" and labels \"foo: bar\", a delivery pipeline resource must match both that id and have that label in order to be subject to the policy.", + "id": "DeployPolicyResourceSelector", + "properties": { + "deliveryPipeline": { + "$ref": "DeliveryPipelineAttribute", + "description": "Optional. Contains attributes about a delivery pipeline." + }, + "target": { + "$ref": "TargetAttribute", + "description": "Optional. Contains attributes about a target." + } + }, + "type": "object" + }, "DeploymentJobs": { "description": "Deployment job composition.", "id": "DeploymentJobs", @@ -3573,6 +4033,13 @@ "description": "Required. The job ID for the Job to ignore.", "type": "string" }, + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" + }, "phaseId": { "description": "Required. The phase ID the Job to ignore belongs to.", "type": "string" @@ -3811,6 +4278,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3821,6 +4289,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3831,6 +4300,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3953,6 +4423,31 @@ }, "type": "object" }, + "ListDeployPoliciesResponse": { + "description": "The response object from `ListDeployPolicies`.", + "id": "ListDeployPoliciesResponse", + "properties": { + "deployPolicies": { + "description": "The `DeployPolicy` objects.", + "items": { + "$ref": "DeployPolicy" + }, + "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" + }, "ListJobRunsResponse": { "description": "ListJobRunsResponse is the response object returned by `ListJobRuns`.", "id": "ListJobRunsResponse", @@ -4159,6 +4654,29 @@ }, "type": "object" }, + "OneTimeWindow": { + "description": "One-time window within which actions are restricted. For example, blocking actions over New Year's Eve from December 31st at 5pm to January 1st at 9am.", + "id": "OneTimeWindow", + "properties": { + "endDate": { + "$ref": "Date", + "description": "Required. End date." + }, + "endTime": { + "$ref": "TimeOfDay", + "description": "Required. End time (exclusive). You may use 24:00 for the end of the day." + }, + "startDate": { + "$ref": "Date", + "description": "Required. Start date." + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Required. Start time (inclusive). Use 00:00 for the beginning of the day." + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4411,6 +4929,50 @@ }, "type": "object" }, + "PolicyRule": { + "description": "Deploy Policy rule.", + "id": "PolicyRule", + "properties": { + "rolloutRestriction": { + "$ref": "RolloutRestriction", + "description": "Rollout restrictions." + } + }, + "type": "object" + }, + "PolicyViolation": { + "description": "Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why.", + "id": "PolicyViolation", + "properties": { + "policyViolationDetails": { + "description": "Policy violation details.", + "items": { + "$ref": "PolicyViolationDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "PolicyViolationDetails": { + "description": "Policy violation details.", + "id": "PolicyViolationDetails", + "properties": { + "failureMessage": { + "description": "User readable message about why the request violated a policy. This is not intended for machine parsing.", + "type": "string" + }, + "policy": { + "description": "Name of the policy that was violated. Policy resource will be in the format of `projects/{project}/locations/{location}/policies/{policy}`.", + "type": "string" + }, + "ruleId": { + "description": "Id of the rule that triggered the policy violation.", + "type": "string" + } + }, + "type": "object" + }, "Postdeploy": { "description": "Postdeploy contains the postdeploy job configuration information.", "id": "Postdeploy", @@ -4808,6 +5370,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4818,6 +5381,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -4828,6 +5392,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4888,6 +5453,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4898,6 +5464,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -4908,6 +5475,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4949,10 +5517,31 @@ }, "type": "object" }, + "RepairPhaseConfig": { + "description": "Configuration of the repair phase.", + "id": "RepairPhaseConfig", + "properties": { + "retry": { + "$ref": "Retry", + "description": "Optional. Retries a failed job." + }, + "rollback": { + "$ref": "Rollback", + "description": "Optional. Rolls back a `Rollout`." + } + }, + "type": "object" + }, "RepairRolloutOperation": { "description": "Contains the information for an automated `repair rollout` operation.", "id": "RepairRolloutOperation", "properties": { + "currentRepairPhaseIndex": { + "description": "Output only. The index of the current repair action in the repair sequence.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "jobId": { "description": "Output only. The job ID for the Job to repair.", "readOnly": true, @@ -4998,6 +5587,51 @@ "type": "string" }, "type": "array" + }, + "phases": { + "description": "Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "repairPhases": { + "description": "Required. Defines the types of automatic repair phases for failed jobs.", + "items": { + "$ref": "RepairPhaseConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "Retry": { + "description": "Retries the failed job.", + "id": "Retry", + "properties": { + "attempts": { + "description": "Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10.", + "format": "int64", + "type": "string" + }, + "backoffMode": { + "description": "Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0.", + "enum": [ + "BACKOFF_MODE_UNSPECIFIED", + "BACKOFF_MODE_LINEAR", + "BACKOFF_MODE_EXPONENTIAL" + ], + "enumDescriptions": [ + "No WaitMode is specified.", + "Increases the wait time linearly.", + "Increases the wait time exponentially." + ], + "type": "string" + }, + "wait": { + "description": "Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d.", + "format": "google-duration", + "type": "string" } }, "type": "object" @@ -5057,6 +5691,13 @@ "description": "Required. The job ID for the Job to retry.", "type": "string" }, + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" + }, "phaseId": { "description": "Required. The phase ID the Job to retry belongs to.", "type": "string" @@ -5106,6 +5747,21 @@ }, "type": "object" }, + "Rollback": { + "description": "Rolls back a `Rollout`.", + "id": "Rollback", + "properties": { + "destinationPhase": { + "description": "Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase.", + "type": "string" + }, + "disableRollbackIfRolloutPending": { + "description": "Optional. If pending rollout exists on the target, the rollback operation will be aborted.", + "type": "boolean" + } + }, + "type": "object" + }, "RollbackAttempt": { "description": "RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'.", "id": "RollbackAttempt", @@ -5115,6 +5771,11 @@ "readOnly": true, "type": "string" }, + "disableRollbackIfRolloutPending": { + "description": "Output only. If active rollout exists on the target, abort this rollback.", + "readOnly": true, + "type": "boolean" + }, "rolloutId": { "description": "Output only. ID of the rollback `Rollout` to create.", "readOnly": true, @@ -5170,6 +5831,13 @@ "description": "The request object for `RollbackTarget`.", "id": "RollbackTargetRequest", "properties": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deploy_policy}`.", + "items": { + "type": "string" + }, + "type": "array" + }, "releaseId": { "description": "Optional. ID of the `Release` to roll back to. If this isn't specified, the previous successful `Rollout` to the specified target will be used to determine the `Release`.", "type": "string" @@ -5212,6 +5880,11 @@ "description": "A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`.", "id": "Rollout", "properties": { + "activeRepairAutomationRun": { + "description": "Output only. The AutomationRun actively repairing the rollout.", + "readOnly": true, + "type": "string" + }, "annotations": { "additionalProperties": { "type": "string" @@ -5440,6 +6113,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5450,6 +6124,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -5460,6 +6135,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -5467,6 +6143,67 @@ }, "type": "object" }, + "RolloutRestriction": { + "description": "Rollout restrictions.", + "id": "RolloutRestriction", + "properties": { + "actions": { + "description": "Optional. Rollout actions to be restricted as part of the policy. If left empty, all actions will be restricted.", + "items": { + "enum": [ + "ROLLOUT_ACTIONS_UNSPECIFIED", + "ADVANCE", + "APPROVE", + "CANCEL", + "CREATE", + "IGNORE_JOB", + "RETRY_JOB", + "ROLLBACK", + "TERMINATE_JOBRUN" + ], + "enumDescriptions": [ + "Unspecified.", + "Advance the rollout to the next phase.", + "Approve the rollout.", + "Cancel the rollout.", + "Create a rollout.", + "Ignore a job result on the rollout.", + "Retry a job for a rollout.", + "Rollback a rollout.", + "Terminate a jobrun." + ], + "type": "string" + }, + "type": "array" + }, + "id": { + "description": "Required. Restriction rule ID. Required and must be unique within a DeployPolicy. The format is `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`.", + "type": "string" + }, + "invokers": { + "description": "Optional. What invoked the action. If left empty, all invoker types will be restricted.", + "items": { + "enum": [ + "INVOKER_UNSPECIFIED", + "USER", + "DEPLOY_AUTOMATION" + ], + "enumDescriptions": [ + "Unspecified.", + "The action is user-driven. For example, creating a rollout manually via a gcloud create command.", + "Automated action by Cloud Deploy." + ], + "type": "string" + }, + "type": "array" + }, + "timeWindows": { + "$ref": "TimeWindows", + "description": "Required. Time window within which actions are restricted." + } + }, + "type": "object" + }, "RolloutUpdateEvent": { "description": "Payload proto for \"clouddeploy.googleapis.com/rollout_update\" Platform Log event that describes the rollout update event.", "id": "RolloutUpdateEvent", @@ -5541,6 +6278,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -5551,6 +6289,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -5561,6 +6300,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -5991,7 +6731,7 @@ "type": "object" }, "TargetAttribute": { - "description": "Contains criteria for selecting Targets.", + "description": "Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation.", "id": "TargetAttribute", "properties": { "id": { @@ -6030,6 +6770,7 @@ "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", "TYPE_ROLLOUT_UPDATE", + "TYPE_DEPLOY_POLICY_EVALUATION", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -6040,6 +6781,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -6050,6 +6792,7 @@ "Restriction check failed.", "Resource deleted.", "Rollout updated.", + "Deploy Policy evaluation.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -6162,7 +6905,15 @@ "TerminateJobRunRequest": { "description": "The request object used by `TerminateJobRun`.", "id": "TerminateJobRunRequest", - "properties": {}, + "properties": { + "overrideDeployPolicy": { + "description": "Optional. Deploy policies to override. Format is `projects/{project}/locations/{location}/deployPolicies/{deployPolicy}`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, "type": "object" }, "TerminateJobRunResponse": { @@ -6199,6 +6950,58 @@ }, "type": "object" }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TimeWindows": { + "description": "Time windows within which actions are restricted. See the [documentation](https://cloud.google.com/deploy/docs/deploy-policy#dates_times) for more information on how to configure dates/times.", + "id": "TimeWindows", + "properties": { + "oneTimeWindows": { + "description": "Optional. One-time windows within which actions are restricted.", + "items": { + "$ref": "OneTimeWindow" + }, + "type": "array" + }, + "timeZone": { + "description": "Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York).", + "type": "string" + }, + "weeklyWindows": { + "description": "Optional. Recurring weekly windows within which actions are restricted.", + "items": { + "$ref": "WeeklyWindow" + }, + "type": "array" + } + }, + "type": "object" + }, "VerifyJob": { "description": "A verify Job.", "id": "VerifyJob", @@ -6252,6 +7055,48 @@ } }, "type": "object" + }, + "WeeklyWindow": { + "description": "Weekly windows. For example, blocking actions every Saturday and Sunday. Another example would be blocking actions every weekday from 5pm to midnight.", + "id": "WeeklyWindow", + "properties": { + "daysOfWeek": { + "description": "Optional. Days of week. If left empty, all days of the week will be included.", + "items": { + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "type": "array" + }, + "endTime": { + "$ref": "TimeOfDay", + "description": "Optional. End time (exclusive). Use 24:00 to indicate midnight. If you specify end_time you must also specify start_time. If left empty, this will block for the entire day for the days specified in days_of_week." + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Optional. Start time (inclusive). Use 00:00 for the beginning of the day. If you specify start_time you must also specify end_time. If left empty, this will block for the entire day for the days specified in days_of_week." + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 570954a7bd..f3663d1a6b 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -552,7 +552,7 @@ } } }, - "revision": "20240725", + "revision": "20240905", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -987,621 +987,6 @@ }, "type": "object" }, - "GoogleCloudFunctionsV2LocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2LocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2OperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2Stage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2Stage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2Stage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2StateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2StateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2StateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2alphaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2alphaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2alphaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2alphaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2betaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2betaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2betaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2betaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, "HttpsTrigger": { "description": "Describes HttpsTrigger, could be used to connect web hooks to function.", "id": "HttpsTrigger", diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index 623500359f..de44c572e7 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -716,7 +716,7 @@ } } }, - "revision": "20240822", + "revision": "20240905", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1370,416 +1370,6 @@ }, "type": "object" }, - "GoogleCloudFunctionsV2alphaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2alphaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2alphaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2alphaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2alphaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2betaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2betaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2betaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2betaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, "ListFunctionsResponse": { "description": "Response for the `ListFunctions` method.", "id": "ListFunctionsResponse", diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 0405ea5a5d..4fd5ac35b6 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -716,7 +716,7 @@ } } }, - "revision": "20240822", + "revision": "20240905", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1165,211 +1165,6 @@ }, "type": "object" }, - "GoogleCloudFunctionsV2LocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2LocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2OperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2Stage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2Stage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2Stage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2StateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2StateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2StateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudFunctionsV2alphaLocationMetadata": { "description": "Extra GCF specific location information.", "id": "GoogleCloudFunctionsV2alphaLocationMetadata", @@ -1575,211 +1370,6 @@ }, "type": "object" }, - "GoogleCloudFunctionsV2betaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2betaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2betaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2betaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2betaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2betaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2betaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, "ListFunctionsResponse": { "description": "Response for the `ListFunctions` method.", "id": "ListFunctionsResponse", diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index 8afd00254d..ccdd06e508 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -716,7 +716,7 @@ } } }, - "revision": "20240822", + "revision": "20240905", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -1165,416 +1165,6 @@ }, "type": "object" }, - "GoogleCloudFunctionsV2LocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2LocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2OperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2Stage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2Stage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2Stage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2StateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2StateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2StateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaLocationMetadata": { - "description": "Extra GCF specific location information.", - "id": "GoogleCloudFunctionsV2alphaLocationMetadata", - "properties": { - "environments": { - "description": "The Cloud Function environments this location supports.", - "items": { - "enum": [ - "ENVIRONMENT_UNSPECIFIED", - "GEN_1", - "GEN_2" - ], - "enumDescriptions": [ - "Unspecified", - "Gen 1", - "Gen 2" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaOperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "id": "GoogleCloudFunctionsV2alphaOperationMetadata", - "properties": { - "apiVersion": { - "description": "API version used to start the operation.", - "type": "string" - }, - "buildName": { - "description": "The build name of the function for create and update operations.", - "type": "string" - }, - "cancelRequested": { - "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "createTime": { - "description": "The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "OPERATIONTYPE_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION", - "REDIRECT_FUNCTION_UPGRADE_TRAFFIC", - "ROLLBACK_FUNCTION_UPGRADE_TRAFFIC", - "SETUP_FUNCTION_UPGRADE_CONFIG", - "ABORT_FUNCTION_UPGRADE", - "COMMIT_FUNCTION_UPGRADE" - ], - "enumDescriptions": [ - "Unspecified", - "CreateFunction", - "UpdateFunction", - "DeleteFunction", - "RedirectFunctionUpgradeTraffic", - "RollbackFunctionUpgradeTraffic", - "SetupFunctionUpgradeConfig", - "AbortFunctionUpgrade", - "CommitFunctionUpgrade" - ], - "type": "string" - }, - "requestResource": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "sourceToken": { - "description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.", - "type": "string" - }, - "stages": { - "description": "Mechanism for reporting in-progress stages", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStage" - }, - "type": "array" - }, - "statusDetail": { - "description": "Human-readable status of the operation, if any.", - "type": "string" - }, - "target": { - "description": "Server-defined resource path for the target of the operation.", - "type": "string" - }, - "verb": { - "description": "Name of the verb executed by the operation.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStage": { - "description": "Each Stage of the deployment process", - "id": "GoogleCloudFunctionsV2alphaStage", - "properties": { - "message": { - "description": "Message describing the Stage", - "type": "string" - }, - "name": { - "description": "Name of the Stage. This will be unique for each Stage.", - "enum": [ - "NAME_UNSPECIFIED", - "ARTIFACT_REGISTRY", - "BUILD", - "SERVICE", - "TRIGGER", - "SERVICE_ROLLBACK", - "TRIGGER_ROLLBACK" - ], - "enumDescriptions": [ - "Not specified. Invalid name.", - "Artifact Regsitry Stage", - "Build Stage", - "Service Stage", - "Trigger Stage", - "Service Rollback Stage", - "Trigger Rollback Stage" - ], - "type": "string" - }, - "resource": { - "description": "Resource of the Stage", - "type": "string" - }, - "resourceUri": { - "description": "Link to the current Stage resource", - "type": "string" - }, - "state": { - "description": "Current state of the Stage", - "enum": [ - "STATE_UNSPECIFIED", - "NOT_STARTED", - "IN_PROGRESS", - "COMPLETE" - ], - "enumDescriptions": [ - "Not specified. Invalid state.", - "Stage has not started.", - "Stage is in progress.", - "Stage has completed." - ], - "type": "string" - }, - "stateMessages": { - "description": "State messages from the current Stage.", - "items": { - "$ref": "GoogleCloudFunctionsV2alphaStateMessage" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudFunctionsV2alphaStateMessage": { - "description": "Informational messages about the state of the Cloud Function or Operation.", - "id": "GoogleCloudFunctionsV2alphaStateMessage", - "properties": { - "message": { - "description": "The message.", - "type": "string" - }, - "severity": { - "description": "Severity of the state message.", - "enum": [ - "SEVERITY_UNSPECIFIED", - "ERROR", - "WARNING", - "INFO" - ], - "enumDescriptions": [ - "Not specified. Invalid severity.", - "ERROR-level severity.", - "WARNING-level severity.", - "INFO-level severity." - ], - "type": "string" - }, - "type": { - "description": "One-word CamelCase type of the state message.", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudFunctionsV2betaLocationMetadata": { "description": "Extra GCF specific location information.", "id": "GoogleCloudFunctionsV2betaLocationMetadata", diff --git a/discovery/cloudidentity-v1.json b/discovery/cloudidentity-v1.json index 4a529ef816..8f0943f734 100644 --- a/discovery/cloudidentity-v1.json +++ b/discovery/cloudidentity-v1.json @@ -1990,7 +1990,7 @@ } } }, - "revision": "20240820", + "revision": "20240924", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2347,7 +2347,7 @@ "type": "string" }, "lastProfileSyncTime": { - "description": "Timestamp in milliseconds since Epoch when the profile/gcm id was last synced.", + "description": "Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced.", "format": "google-datetime", "type": "string" } @@ -2355,7 +2355,7 @@ "type": "object" }, "GoogleAppsCloudidentityDevicesV1BrowserInfo": { - "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange", + "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", "id": "GoogleAppsCloudidentityDevicesV1BrowserInfo", "properties": { "browserManagementState": { @@ -2378,7 +2378,7 @@ "type": "string" }, "browserVersion": { - "description": "Version of the request initiating browser.", + "description": "Version of the request initiating browser. E.g. `91.0.4442.4`.", "type": "string" }, "isBuiltInDnsClientEnabled": { @@ -3083,7 +3083,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", + "description": "[Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", "type": "object" }, "browserAttributes": { @@ -3732,6 +3732,7 @@ "SERVICE_ACCOUNT", "GROUP", "SHARED_DRIVE", + "CBCM_BROWSER", "OTHER" ], "enumDescriptions": [ @@ -3740,6 +3741,7 @@ "Represents service account type.", "Represents group type.", "Represents Shared drive.", + "Represents a CBCM-managed Chrome Browser type.", "Represents other type." ], "readOnly": true, diff --git a/discovery/cloudidentity-v1beta1.json b/discovery/cloudidentity-v1beta1.json index 5878d594c0..b7592661d4 100644 --- a/discovery/cloudidentity-v1beta1.json +++ b/discovery/cloudidentity-v1beta1.json @@ -2015,7 +2015,7 @@ } } }, - "revision": "20240625", + "revision": "20241001", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { @@ -2136,19 +2136,19 @@ "type": "object" }, "BrowserAttributes": { - "description": "Contains information about browser profiles reported by the Endpoint Verification extension.", + "description": "Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", "id": "BrowserAttributes", "properties": { "chromeBrowserInfo": { "$ref": "BrowserInfo", - "description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the Endpoint Verification extension." + "description": "Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1)." }, "chromeProfileId": { "description": "Chrome profile ID that is exposed by the Chrome API. It is unique for each device.", "type": "string" }, "lastProfileSyncTime": { - "description": "Timestamp in milliseconds since Epoch when the profile/gcm id was last synced.", + "description": "Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced.", "format": "google-datetime", "type": "string" } @@ -2156,7 +2156,7 @@ "type": "object" }, "BrowserInfo": { - "description": "Browser-specific fields reported by the Endpoint Verification extension. LINT.IfChange", + "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", "id": "BrowserInfo", "properties": { "browserManagementState": { @@ -2179,7 +2179,7 @@ "type": "string" }, "browserVersion": { - "description": "Version of the request initiating browser.", + "description": "Version of the request initiating browser. E.g. `91.0.4442.4`.", "type": "string" }, "isBuiltInDnsClientEnabled": { @@ -3024,7 +3024,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. Configurable attributes: file_config, registry_config, and plist_config.", + "description": "[Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", "type": "object" }, "browserAttributes": { @@ -3190,7 +3190,7 @@ "type": "string" }, "lastProfileSyncTime": { - "description": "Timestamp in milliseconds since Epoch when the profile/gcm id was last synced.", + "description": "Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced.", "format": "google-datetime", "type": "string" } @@ -3198,7 +3198,7 @@ "type": "object" }, "GoogleAppsCloudidentityDevicesV1BrowserInfo": { - "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange", + "description": "Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1).", "id": "GoogleAppsCloudidentityDevicesV1BrowserInfo", "properties": { "browserManagementState": { @@ -3221,7 +3221,7 @@ "type": "string" }, "browserVersion": { - "description": "Version of the request initiating browser.", + "description": "Version of the request initiating browser. E.g. `91.0.4442.4`.", "type": "string" }, "isBuiltInDnsClientEnabled": { @@ -3904,7 +3904,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", + "description": "[Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist.", "type": "object" }, "browserAttributes": { @@ -4557,6 +4557,7 @@ "SERVICE_ACCOUNT", "GROUP", "SHARED_DRIVE", + "CBCM_BROWSER", "OTHER" ], "enumDescriptions": [ @@ -4565,6 +4566,7 @@ "Represents service account type.", "Represents group type.", "Represents Shared drive.", + "Represents a CBCM-managed Chrome Browser type.", "Represents other type." ], "readOnly": true, @@ -4804,7 +4806,7 @@ "type": "object" }, "PosixGroup": { - "description": "POSIX Group definition to represent a group in a POSIX compliant system.", + "description": "POSIX Group definition to represent a group in a POSIX compliant system. Caution: POSIX groups are deprecated. As of September 26, 2024, you can no longer create new POSIX groups. For more information, see https://cloud.google.com/identity/docs/deprecations/posix-groups", "id": "PosixGroup", "properties": { "gid": { diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index e37d32e6aa..607e018742 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -24,6 +24,11 @@ "endpointUrl": "https://cloudkms.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.europe-west9.rep.googleapis.com/", @@ -78,6 +83,21 @@ "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-west4.rep.googleapis.com/", "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-south1.rep.googleapis.com/", + "location": "us-south1" } ], "fullyEncodeReservedExpansion": true, @@ -860,7 +880,7 @@ "type": "string" }, "pageSize": { - "description": "Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most KeyHandles 100 will be returned.", + "description": "Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned.", "format": "int32", "location": "query", "type": "integer" @@ -2112,7 +2132,7 @@ } } }, - "revision": "20240808", + "revision": "20240926", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { diff --git a/discovery/cloudscheduler-v1.json b/discovery/cloudscheduler-v1.json index e24416a741..9fdcc84372 100644 --- a/discovery/cloudscheduler-v1.json +++ b/discovery/cloudscheduler-v1.json @@ -105,6 +105,117 @@ }, "protocol": "rest", "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/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "cloudscheduler.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + } + }, + "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/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "cloudscheduler.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + } + }, + "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/operations/{operationsId}", + "httpMethod": "GET", + "id": "cloudscheduler.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^operations/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + } + }, + "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/operations", + "httpMethod": "GET", + "id": "cloudscheduler.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": "^operations$", + "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}", + "response": { + "$ref": "ListOperationsResponse" + } + } + } + }, "projects": { "resources": { "locations": { @@ -418,7 +529,7 @@ } } }, - "revision": "20240126", + "revision": "20240917", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -495,6 +606,12 @@ }, "type": "object" }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -678,6 +795,24 @@ }, "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", @@ -742,6 +877,85 @@ }, "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" + }, + "cancelRequested": { + "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" + }, + "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" + }, + "statusDetail": { + "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" + }, "PauseJobRequest": { "description": "Request message for PauseJob.", "id": "PauseJobRequest", diff --git a/discovery/cloudscheduler-v1beta1.json b/discovery/cloudscheduler-v1beta1.json index 48f216b9d0..a3d0e03a87 100644 --- a/discovery/cloudscheduler-v1beta1.json +++ b/discovery/cloudscheduler-v1beta1.json @@ -433,7 +433,7 @@ } } }, - "revision": "20240126", + "revision": "20240917", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -761,6 +761,50 @@ }, "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" + }, + "cancelRequested": { + "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" + }, + "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" + }, + "statusDetail": { + "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" + }, "PauseJobRequest": { "description": "Request message for PauseJob.", "id": "PauseJobRequest", diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index bf63b3a4a3..a1acd36b4d 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -15,6 +15,13 @@ "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/composer/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://composer.us-south1.rep.googleapis.com/", + "location": "us-south1" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -966,7 +973,7 @@ } } }, - "revision": "20240716", + "revision": "20240917", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index b0ae932429..6a65a04601 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -15,6 +15,13 @@ "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/composer/", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://composer.us-south1.rep.googleapis.com/", + "location": "us-south1" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -994,7 +1001,7 @@ } } }, - "revision": "20240716", + "revision": "20240917", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index e78d01b83f..1ad1e3b938 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -2062,7 +2062,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project.", + "description": "Retrieves a list of all usable backend services in the specified project.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -12585,6 +12585,56 @@ "https://www.googleapis.com/auth/compute" ] }, + "reportHostAsFaulty": { + "description": "Mark the host as faulty and try to restart the instance on a new host.", + "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", + "httpMethod": "POST", + "id": "compute.instances.reportHostAsFaulty", + "parameterOrder": [ + "project", + "zone", + "instance" + ], + "parameters": { + "instance": { + "description": "Name of the instance scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty", + "request": { + "$ref": "InstancesReportHostAsFaultyRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "reset": { "description": "Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance.", "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset", @@ -14231,6 +14281,55 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.instantSnapshotGroups.getIamPolicy", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{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": "inserts a Zonal InstantSnapshotGroup resource", "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", @@ -14340,184 +14439,275 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] - } - } - }, - "instantSnapshots": { - "methods": { - "aggregatedList": { - "description": "Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", - "flatPath": "projects/{project}/aggregated/instantSnapshots", - "httpMethod": "GET", - "id": "compute.instantSnapshots.aggregatedList", - "parameterOrder": [ - "project" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "includeAllScopes": { - "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", - "location": "query", - "type": "boolean" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - }, - "serviceProjectNumber": { - "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/aggregated/instantSnapshots", - "response": { - "$ref": "InstantSnapshotAggregatedList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "delete": { - "description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.", - "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", - "httpMethod": "DELETE", - "id": "compute.instantSnapshots.delete", - "parameterOrder": [ - "project", - "zone", - "instantSnapshot" - ], - "parameters": { - "instantSnapshot": { - "description": "Name of the InstantSnapshot resource to delete.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - }, - "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Returns the specified InstantSnapshot resource in the specified zone.", - "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", - "httpMethod": "GET", - "id": "compute.instantSnapshots.get", - "parameterOrder": [ - "project", - "zone", - "instantSnapshot" - ], - "parameters": { - "instantSnapshot": { - "description": "Name of the InstantSnapshot resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the zone for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", - "response": { - "$ref": "InstantSnapshot" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", - "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", - "httpMethod": "GET", - "id": "compute.instantSnapshots.getIamPolicy", + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.instantSnapshotGroups.setIamPolicy", "parameterOrder": [ "project", "zone", "resource" ], "parameters": { - "optionsRequestedPolicyVersion": { - "description": "Requested IAM Policy version.", - "format": "int32", - "location": "query", - "type": "integer" - }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy", + "request": { + "$ref": "ZoneSetPolicyRequest" + }, + "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}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.instantSnapshotGroups.testIamPermissions", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{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" + ] + } + } + }, + "instantSnapshots": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/instantSnapshots", + "httpMethod": "GET", + "id": "compute.instantSnapshots.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/instantSnapshots", + "response": { + "$ref": "InstantSnapshotAggregatedList" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "delete": { + "description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", + "httpMethod": "DELETE", + "id": "compute.instantSnapshots.delete", + "parameterOrder": [ + "project", + "zone", + "instantSnapshot" + ], + "parameters": { + "instantSnapshot": { + "description": "Name of the InstantSnapshot resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns the specified InstantSnapshot resource in the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", + "httpMethod": "GET", + "id": "compute.instantSnapshots.get", + "parameterOrder": [ + "project", + "zone", + "instantSnapshot" + ], + "parameters": { + "instantSnapshot": { + "description": "Name of the InstantSnapshot resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}", + "response": { + "$ref": "InstantSnapshot" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.instantSnapshots.getIamPolicy", + "parameterOrder": [ + "project", + "zone", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -23957,7 +24147,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project in the given region.", + "description": "Retrieves a list of all usable backend services in the specified project in the given region.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -26471,11 +26661,115 @@ }, "regionInstanceGroupManagerResizeRequests": { "methods": { - "get": { - "description": "Returns all of the details about the specified resize request.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", - "httpMethod": "GET", - "id": "compute.regionInstanceGroupManagerResizeRequests.get", + "cancel": { + "description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.cancel", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "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" + }, + "resizeRequest": { + "description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "DELETE", + "id": "compute.regionInstanceGroupManagerResizeRequests.delete", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "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" + }, + "resizeRequest": { + "description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.get", "parameterOrder": [ "project", "region", @@ -28633,6 +28927,55 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy", + "httpMethod": "GET", + "id": "compute.regionInstantSnapshotGroups.getIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "optionsRequestedPolicyVersion": { + "description": "Requested IAM Policy version.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{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 Regional InstantSnapshotGroup resource", "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", @@ -28742,6 +29085,97 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.regionInstantSnapshotGroups.setIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" + }, + "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}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions", + "httpMethod": "POST", + "id": "compute.regionInstantSnapshotGroups.testIamPermissions", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{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" + ] } } }, @@ -33995,6 +34429,125 @@ } } }, + "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" + ] + } + } + }, "reservations": { "methods": { "aggregatedList": { @@ -45055,7 +45608,7 @@ } } }, - "revision": "20240820", + "revision": "20240919", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46471,6 +47024,11 @@ "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", "properties": { + "reservationBlockCount": { + "description": "Indicates number of blocks for accelerator optimized family (applicable beyond A3 only).", + "format": "int32", + "type": "integer" + }, "specificSkuAllocation": { "$ref": "AllocationResourceStatusSpecificSKUAllocation", "description": "Allocation Properties of this reservation." @@ -48524,6 +49082,13 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "customMetrics": { + "description": "List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy.", + "items": { + "$ref": "BackendServiceCustomMetric" + }, + "type": "array" + }, "customRequestHeaders": { "description": "Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers).", "items": { @@ -49148,6 +49713,21 @@ }, "type": "object" }, + "BackendServiceCustomMetric": { + "description": "Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy.", + "id": "BackendServiceCustomMetric", + "properties": { + "dryRun": { + "description": "If true, the metric data is not used for load balancing.", + "type": "boolean" + }, + "name": { + "description": "Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "type": "string" + } + }, + "type": "object" + }, "BackendServiceFailoverPolicy": { "description": "For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).", "id": "BackendServiceFailoverPolicy", @@ -50348,7 +50928,7 @@ }, "locationPolicy": { "$ref": "LocationPolicy", - "description": "Policy for chosing target zone. For more information, see Create VMs in bulk ." + "description": "Policy for choosing target zone. For more information, see Create VMs in bulk." }, "minCount": { "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.", @@ -60399,6 +60979,10 @@ ], "type": "string" }, + "multiMig": { + "description": "URL to the multi-MIG that this Managed Instance Group belongs to.", + "type": "string" + }, "name": { "annotations": { "required": [ @@ -64089,6 +64673,42 @@ }, "type": "object" }, + "InstancesReportHostAsFaultyRequest": { + "id": "InstancesReportHostAsFaultyRequest", + "properties": { + "faultReasons": { + "items": { + "$ref": "InstancesReportHostAsFaultyRequestFaultReason" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstancesReportHostAsFaultyRequestFaultReason": { + "id": "InstancesReportHostAsFaultyRequestFaultReason", + "properties": { + "behavior": { + "enum": [ + "BEHAVIOR_UNSPECIFIED", + "PERFORMANCE", + "SILENT_DATA_CORRUPTION", + "UNRECOVERABLE_GPU_ERROR" + ], + "enumDescriptions": [ + "Public reportable behaviors", + "", + "", + "" + ], + "type": "string" + }, + "description": { + "type": "string" + } + }, + "type": "object" + }, "InstancesResumeRequest": { "id": "InstancesResumeRequest", "properties": { @@ -65072,7 +65692,7 @@ "description": "Configuration for enabling Application Aware Interconnect (AAI) on this Cloud Interconnect connection between Google and your on-premises router." }, "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ "IF_MACSEC" @@ -65225,7 +65845,7 @@ "type": "string" }, "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ "IF_MACSEC" @@ -65355,6 +65975,7 @@ "bandwidth": { "description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s ", "enum": [ + "BPS_100G", "BPS_100M", "BPS_10G", "BPS_1G", @@ -65369,6 +65990,7 @@ "BPS_5G" ], "enumDescriptions": [ + "100 Gbit/s", "100 Mbit/s", "10 Gbit/s", "1 Gbit/s", @@ -69404,6 +70026,9 @@ ], "type": "string" }, + "currentActionDetails": { + "$ref": "ManagedInstanceCurrentActionDetails" + }, "id": { "description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.", "format": "uint64", @@ -69523,6 +70148,45 @@ }, "type": "object" }, + "ManagedInstanceCurrentActionDetails": { + "id": "ManagedInstanceCurrentActionDetails", + "properties": { + "methodName": { + "type": "string" + }, + "trigger": { + "description": "[Output Only] Details of the current action that the managed instance group has scheduled for the instance. Contains trigger for the current action, and methodName in case it was triggered by API call. Possible values for trigger: - API Any API call. - PROACTIVE_UPDATE Proactive updater scheduled an update on this managed instance. - AUTOSCALING Instance being deleted/created after a decision from the Autoscaler. - REDISTRIBUTION The regional managed instance group is moving instances between zones to restore balance. - STANDBY_REFILL The managed instance group is refilling the Standby Pool (stopped/suspended virtual machines) after scale up. - MAINTENANCE Manual maintenance. - FAILED_CREATION The managed instance group is handling failed instance creation. - INSTANCE_FAILURE The managed instance group is handling instance failure, according to the Instance Lifecycle Policy. - FAILED_HEALTH_CHECK The managed instance group is handling failed health check, according to the Instance Lifecycle Policy. - TERMINATION_TIMESTAMP Instance reached termination time, thus managed instance group stops/deletes it. ", + "enum": [ + "API", + "AUTOSCALING", + "FAILED_CREATION", + "FAILED_HEALTH_CHECK", + "INSTANCE_FAILURE", + "MAINTENANCE", + "NONE", + "PROACTIVE_UPDATE", + "REDISTRIBUTION", + "STANDBY_REFILL", + "TERMINATION_TIMESTAMP" + ], + "enumDescriptions": [ + "Any API call.", + "Instance being deleted/created after a decision from the Autoscaler.", + "The managed instance group is handling failed instance creation.", + "The managed instance group is handling failed health check, according to the Instance Lifecycle Policy.", + "The managed instance group is handling instance failure, according to the Instance Lifecycle Policy.", + "Manual maintenance.", + "Default value, not visible externally.", + "Proactive updater scheduled an update on this managed instance.", + "The regional managed instance group is moving instances between zones to restore balance.", + "The managed instance group is refilling the Standby Pool (stopped/suspended virtual machines) after scale up.", + "Instance reached termination time, thus managed instance group stops/deletes it." + ], + "type": "string" + } + }, + "type": "object" + }, "ManagedInstanceInstanceFlexibilityOverride": { "id": "ManagedInstanceInstanceFlexibilityOverride", "properties": { @@ -81920,6 +82584,20 @@ "description": "Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.", "type": "string" }, + "deploymentType": { + "description": "Specifies the deployment strategy for this reservation.", + "enum": [ + "DENSE", + "DEPLOYMENT_TYPE_UNSPECIFIED", + "FLEXIBLE" + ], + "enumDescriptions": [ + "Number of deployment blocks, size, and topology is fixed during creation and does not change over time. Deployment will be expressed in terms of blocks.", + "Deployment type is unspecified.", + "Distribution of capacity in blocks is not static and can change over time. This is expected to have more obtainability over DENSE deployment. Deployment will not be expressed in terms of blocks." + ], + "type": "string" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -81929,6 +82607,20 @@ "format": "uint64", "type": "string" }, + "instanceTerminationAction": { + "description": "Instance termination action that will be invoked when the reservation is deleted.", + "enum": [ + "DELETE", + "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", + "STOP" + ], + "enumDescriptions": [ + "Delete the VM.", + "Default value. This value is unused.", + "Stop the VM without storing in-memory content. default action." + ], + "type": "string" + }, "kind": { "default": "compute#reservation", "description": "[Output Only] Type of the resource. Always compute#reservations for reservations.", @@ -82206,6 +82898,233 @@ }, "type": "object" }, + "ReservationBlock": { + "description": "Represents a reservation block resource.", + "id": "ReservationBlock", + "properties": { + "count": { + "description": "[Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular 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] Indicates how many instances are in use on this block.", + "format": "int32", + "type": "integer" + }, + "kind": { + "description": "[Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks.", + "type": "string" + }, + "locationPrefix": { + "description": "[Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003", + "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" + }, + "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" + }, + "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", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "ReservationList": { "id": "ReservationList", "properties": { @@ -84157,6 +85076,10 @@ "RoutePolicy": { "id": "RoutePolicy", "properties": { + "description": { + "description": "An optional description of route policy.", + "type": "string" + }, "fingerprint": { "description": "A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy.", "format": "byte", @@ -87109,7 +88032,8 @@ "type": "array" }, "cloudArmorConfig": { - "$ref": "SecurityPolicyCloudArmorConfig" + "$ref": "SecurityPolicyCloudArmorConfig", + "deprecated": true }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", @@ -87123,6 +88047,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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" @@ -87171,6 +88096,7 @@ "type": "string" }, "ruleTupleCount": { + "deprecated": true, "description": "[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.", "format": "int32", "type": "integer" @@ -87427,6 +88353,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "[Output Only] The display name of the security policy of the association.", "type": "string" }, @@ -87464,6 +88391,7 @@ "id": "SecurityPolicyCloudArmorConfig", "properties": { "enableMl": { + "deprecated": true, "description": "If set to true, enables Cloud Armor Machine Learning.", "type": "boolean" } @@ -87678,6 +88606,7 @@ "type": "string" }, "direction": { + "deprecated": true, "description": "The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.", "enum": [ "EGRESS", @@ -87690,6 +88619,7 @@ "type": "string" }, "enableLogging": { + "deprecated": true, "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules. This field may only be specified when the versioned_expr is set to FIREWALL.", "type": "boolean" }, @@ -87756,11 +88686,13 @@ "type": "string" }, "ruleTupleCount": { + "deprecated": true, "description": "[Output Only] Calculation of the complexity of a single firewall security policy rule.", "format": "int32", "type": "integer" }, "targetResources": { + "deprecated": true, "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. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87768,6 +88700,7 @@ "type": "array" }, "targetServiceAccounts": { + "deprecated": true, "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", "items": { "type": "string" @@ -87839,6 +88772,7 @@ "id": "SecurityPolicyRuleMatcherConfig", "properties": { "destIpRanges": { + "deprecated": true, "description": "CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87846,6 +88780,7 @@ "type": "array" }, "destPorts": { + "deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigDestinationPort" @@ -87853,6 +88788,7 @@ "type": "array" }, "layer4Configs": { + "deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigLayer4Config" @@ -87873,10 +88809,12 @@ "id": "SecurityPolicyRuleMatcherConfigDestinationPort", "properties": { "ipProtocol": { + "deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { + "deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -87890,10 +88828,12 @@ "id": "SecurityPolicyRuleMatcherConfigLayer4Config", "properties": { "ipProtocol": { + "deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { + "deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -93287,7 +94227,7 @@ "type": "string" }, "internalIpv6Prefix": { - "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.", + "description": "The internal IPv6 address range that is owned by this subnetwork.", "type": "string" }, "ipCidrRange": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 87a540b67a..cd2743cf79 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -2007,7 +2007,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project.", + "description": "Retrieves a list of all usable backend services in the specified project.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -22797,7 +22797,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project in the given region.", + "description": "Retrieves a list of all usable backend services in the specified project in the given region.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -25057,6 +25057,279 @@ } } }, + "regionInstanceGroupManagerResizeRequests": { + "methods": { + "cancel": { + "description": "Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.cancel", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "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" + }, + "resizeRequest": { + "description": "The name of the resize request to cancel. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "DELETE", + "id": "compute.regionInstanceGroupManagerResizeRequests.delete", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "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" + }, + "resizeRequest": { + "description": "The name of the resize request to delete. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.get", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.insert", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "request": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "Retrieves a list of Resize Requests that are contained in the managed instance group.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.list", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "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" + }, + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request. Name should conform to RFC1035.", + "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" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "response": { + "$ref": "RegionInstanceGroupManagerResizeRequestsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -41911,7 +42184,7 @@ } } }, - "revision": "20240820", + "revision": "20240919", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44714,6 +44987,13 @@ "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" + }, + "usedBy": { + "description": "[Output Only] List of resources referencing that backend bucket.", + "items": { + "$ref": "BackendBucketUsedBy" + }, + "type": "array" } }, "type": "object" @@ -45000,6 +45280,16 @@ }, "type": "object" }, + "BackendBucketUsedBy": { + "id": "BackendBucketUsedBy", + "properties": { + "reference": { + "description": "[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket.", + "type": "string" + } + }, + "type": "object" + }, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -46662,7 +46952,7 @@ }, "locationPolicy": { "$ref": "LocationPolicy", - "description": "Policy for chosing target zone. For more information, see Create VMs in bulk ." + "description": "Policy for choosing target zone. For more information, see Create VMs in bulk." }, "minCount": { "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.", @@ -55913,6 +56203,10 @@ ], "type": "string" }, + "multiMig": { + "description": "URL to the multi-MIG that this Managed Instance Group belongs to.", + "type": "string" + }, "name": { "annotations": { "required": [ @@ -60202,7 +60496,7 @@ "type": "boolean" }, "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ "IF_MACSEC" @@ -60355,7 +60649,7 @@ "type": "string" }, "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ "IF_MACSEC" @@ -65723,6 +66017,11 @@ "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", "type": "string" }, + "producerPort": { + "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "format": "int32", + "type": "integer" + }, "pscConnectionId": { "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", "format": "uint64", @@ -73164,6 +73463,167 @@ }, "type": "object" }, + "RegionInstanceGroupManagerResizeRequestsListResponse": { + "id": "RegionInstanceGroupManagerResizeRequestsListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of Resize Request resources.", + "items": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "type": "array" + }, + "kind": { + "default": "compute#regionInstanceGroupManagerResizeRequestList", + "description": "[Output Only] Type of the resource. Always compute#regionInstanceGroupManagerResizeRequestList for a list of Resize Requests.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "RegionInstanceGroupManagerUpdateInstanceConfigReq": { "description": "RegionInstanceGroupManagers.updatePerInstanceConfigs", "id": "RegionInstanceGroupManagerUpdateInstanceConfigReq", @@ -74078,6 +74538,11 @@ "backendService": { "description": "The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. ", "type": "string" + }, + "mirrorPercent": { + "description": "The percentage of requests to be mirrored to `backend_service`.", + "format": "double", + "type": "number" } }, "type": "object" @@ -78755,6 +79220,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "User-provided name of the organization security policy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with https://www.ietf.org/rfc/rfc1035.txt. 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" @@ -78803,6 +79269,7 @@ "type": "string" }, "ruleTupleCount": { + "deprecated": true, "description": "[Output Only] Total count of all security policy rule tuples. A security policy can not exceed a set number of tuples.", "format": "int32", "type": "integer" @@ -79057,6 +79524,7 @@ "type": "string" }, "displayName": { + "deprecated": true, "description": "[Output Only] The display name of the security policy of the association.", "type": "string" }, @@ -79287,6 +79755,7 @@ "type": "string" }, "direction": { + "deprecated": true, "description": "The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL.", "enum": [ "EGRESS", @@ -79299,6 +79768,7 @@ "type": "string" }, "enableLogging": { + "deprecated": true, "description": "Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on \"goto_next\" rules. This field may only be specified when the versioned_expr is set to FIREWALL.", "type": "boolean" }, @@ -79346,11 +79816,13 @@ "type": "string" }, "ruleTupleCount": { + "deprecated": true, "description": "[Output Only] Calculation of the complexity of a single firewall security policy rule.", "format": "int32", "type": "integer" }, "targetResources": { + "deprecated": true, "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. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -79358,6 +79830,7 @@ "type": "array" }, "targetServiceAccounts": { + "deprecated": true, "description": "A list of service accounts indicating the sets of instances that are applied with this rule.", "items": { "type": "string" @@ -79429,6 +79902,7 @@ "id": "SecurityPolicyRuleMatcherConfig", "properties": { "destIpRanges": { + "deprecated": true, "description": "CIDR IP address range. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -79436,6 +79910,7 @@ "type": "array" }, "layer4Configs": { + "deprecated": true, "description": "Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "$ref": "SecurityPolicyRuleMatcherConfigLayer4Config" @@ -79456,10 +79931,12 @@ "id": "SecurityPolicyRuleMatcherConfigLayer4Config", "properties": { "ipProtocol": { + "deprecated": true, "description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.", "type": "string" }, "ports": { + "deprecated": true, "description": "An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"]. This field may only be specified when versioned_expr is set to FIREWALL.", "items": { "type": "string" @@ -84292,7 +84769,7 @@ "type": "string" }, "internalIpv6Prefix": { - "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.", + "description": "The internal IPv6 address range that is owned by this subnetwork.", "type": "string" }, "ipCidrRange": { diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 2f695b78eb..2036743f2c 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -1915,7 +1915,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project.", + "description": "Retrieves a list of all usable backend services in the specified project.", "flatPath": "projects/{project}/global/backendServices/listUsable", "httpMethod": "GET", "id": "compute.backendServices.listUsable", @@ -20638,7 +20638,7 @@ ] }, "listUsable": { - "description": "Retrieves an aggregated list of all usable backend services in the specified project in the given region.", + "description": "Retrieves a list of all usable backend services in the specified project in the given region.", "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", "httpMethod": "GET", "id": "compute.regionBackendServices.listUsable", @@ -37779,7 +37779,7 @@ } } }, - "revision": "20240820", + "revision": "20240919", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40488,6 +40488,13 @@ "selfLink": { "description": "[Output Only] Server-defined URL for the resource.", "type": "string" + }, + "usedBy": { + "description": "[Output Only] List of resources referencing that backend bucket.", + "items": { + "$ref": "BackendBucketUsedBy" + }, + "type": "array" } }, "type": "object" @@ -40774,6 +40781,16 @@ }, "type": "object" }, + "BackendBucketUsedBy": { + "id": "BackendBucketUsedBy", + "properties": { + "reference": { + "description": "[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket.", + "type": "string" + } + }, + "type": "object" + }, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -42291,7 +42308,7 @@ }, "locationPolicy": { "$ref": "LocationPolicy", - "description": "Policy for chosing target zone. For more information, see Create VMs in bulk ." + "description": "Policy for choosing target zone. For more information, see Create VMs in bulk." }, "minCount": { "description": "The minimum number of instances to create. If no min_count is specified then count is used as the default value. If min_count instances cannot be created, then no instances will be created and instances already created will be deleted.", @@ -43183,12 +43200,14 @@ "enum": [ "CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED", "SEV", - "SEV_SNP" + "SEV_SNP", + "TDX" ], "enumDescriptions": [ "No type specified. Do not use this value.", "AMD Secure Encrypted Virtualization.", - "AMD Secure Encrypted Virtualization - Secure Nested Paging." + "AMD Secure Encrypted Virtualization - Secure Nested Paging.", + "Intel Trust Domain eXtension." ], "type": "string" }, @@ -47969,6 +47988,7 @@ "SEV_LIVE_MIGRATABLE", "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", + "TDX_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", "WINDOWS" @@ -47985,6 +48005,7 @@ "", "", "", + "", "" ], "type": "string" @@ -55226,7 +55247,7 @@ "type": "boolean" }, "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ "IF_MACSEC" @@ -55379,7 +55400,7 @@ "type": "string" }, "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ "IF_MACSEC" @@ -60158,6 +60179,11 @@ "description": "Metadata defined as annotations on the network endpoint.", "type": "object" }, + "clientDestinationPort": { + "description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type.", + "format": "int32", + "type": "integer" + }, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -60237,6 +60263,7 @@ "enum": [ "GCE_VM_IP", "GCE_VM_IP_PORT", + "GCE_VM_IP_PORTMAP", "INTERNET_FQDN_PORT", "INTERNET_IP_PORT", "NON_GCP_PRIVATE_IP_PORT", @@ -60246,6 +60273,7 @@ "enumDescriptions": [ "The network endpoint is represented by an IP address.", "The network endpoint is represented by IP address and port pair.", + "The network endpoint is represented by an IP, Port and Client Destination Port.", "The network endpoint is represented by fully qualified domain name and port.", "The network endpoint is represented by an internet IP address and port.", "The network endpoint is represented by an IP address and port. The endpoint belongs to a VM or pod running in a customer's on-premises.", @@ -60656,6 +60684,11 @@ "description": "[Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB.", "type": "string" }, + "producerPort": { + "description": "The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type", + "format": "int32", + "type": "integer" + }, "pscConnectionId": { "description": "[Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer.", "format": "uint64", @@ -78068,7 +78101,7 @@ "type": "string" }, "internalIpv6Prefix": { - "description": "[Output Only] The internal IPv6 address range that is assigned to this subnetwork.", + "description": "The internal IPv6 address range that is owned by this subnetwork.", "type": "string" }, "ipCidrRange": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index b4b6a8455a..7e5b96a776 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -2288,6 +2288,46 @@ "resources": { "versions": { "methods": { + "fetchAuthSchema": { + "description": "fetch and return the list of auth config variables required to override the connection backend auth.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}:fetchAuthSchema", + "httpMethod": "GET", + "id": "connectors.projects.locations.providers.connectors.versions.fetchAuthSchema", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Parent resource of the Connector Version, of the form: `projects/*/locations/*/providers/*/connectors/*/versions/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/providers/[^/]+/connectors/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. View of the AuthSchema. The default value is BASIC.", + "enum": [ + "AUTH_SCHEMA_VIEW_UNSPECIFIED", + "BASIC", + "JSON_SCHEMA" + ], + "enumDescriptions": [ + "Default value.", + "Basic view of the AuthSchema.", + "JSON schema view of the AuthSchema." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:fetchAuthSchema", + "response": { + "$ref": "FetchAuthSchemaResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single connector version.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/providers/{providersId}/connectors/{connectorsId}/versions/{versionsId}", @@ -2457,7 +2497,7 @@ } } }, - "revision": "20240822", + "revision": "20240924", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2532,7 +2572,8 @@ "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", - "GOOGLE_AUTHENTICATION" + "GOOGLE_AUTHENTICATION", + "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2541,7 +2582,8 @@ "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", - "Google authentication" + "Google authentication", + "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -2549,6 +2591,10 @@ "$ref": "Oauth2AuthCodeFlow", "description": "Oauth2AuthCodeFlow." }, + "oauth2AuthCodeFlowGoogleManaged": { + "$ref": "Oauth2AuthCodeFlowGoogleManaged", + "description": "Oauth2AuthCodeFlowGoogleManaged." + }, "oauth2ClientCredentials": { "$ref": "Oauth2ClientCredentials", "description": "Oauth2ClientCredentials." @@ -2585,7 +2631,8 @@ "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", - "GOOGLE_AUTHENTICATION" + "GOOGLE_AUTHENTICATION", + "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -2594,7 +2641,8 @@ "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", - "Google authentication" + "Google authentication", + "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -2620,6 +2668,132 @@ }, "type": "object" }, + "AuthField": { + "description": "AuthField defines a field in an authentication type.", + "id": "AuthField", + "properties": { + "dataType": { + "description": "Data type of the field.", + "type": "string" + }, + "description": { + "description": "Description of the field.", + "type": "string" + }, + "key": { + "description": "Key of the field.", + "type": "string" + } + }, + "type": "object" + }, + "AuthObject": { + "description": "AuthObject defines a JSON schema of an authentication type.", + "id": "AuthObject", + "properties": { + "additionalProperties": { + "description": "Whether the object has additional properties.", + "type": "boolean" + }, + "authKey": { + "description": "Auth key of the object.", + "type": "string" + }, + "authType": { + "description": "Auth type of the object.", + "type": "string" + }, + "description": { + "description": "Description of the object.", + "type": "string" + }, + "isDefault": { + "description": "Whether the object is the default one.", + "type": "boolean" + }, + "properties": { + "additionalProperties": { + "$ref": "AuthProperty" + }, + "description": "Properties of the object.", + "type": "object" + }, + "type": { + "description": "Type of the object.", + "type": "string" + } + }, + "type": "object" + }, + "AuthProperty": { + "description": "AuthProperty defines a property of an authentication type.", + "id": "AuthProperty", + "properties": { + "description": { + "description": "Description of the property.", + "type": "string" + }, + "type": { + "description": "Type of the property.", + "type": "string" + } + }, + "type": "object" + }, + "AuthSchema": { + "description": "AuthSchema defines the schema of an authentication type.", + "id": "AuthSchema", + "properties": { + "authFields": { + "description": "List of AuthFields.", + "items": { + "$ref": "AuthField" + }, + "type": "array" + }, + "authKey": { + "description": "Auth key of the schema.", + "type": "string" + }, + "authType": { + "description": "Auth type of the schema.", + "enum": [ + "AUTH_TYPE_UNSPECIFIED", + "USER_PASSWORD", + "OAUTH2_JWT_BEARER", + "OAUTH2_CLIENT_CREDENTIALS", + "SSH_PUBLIC_KEY", + "OAUTH2_AUTH_CODE_FLOW", + "GOOGLE_AUTHENTICATION", + "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" + ], + "enumDescriptions": [ + "Authentication type not specified.", + "Username and Password Authentication.", + "JSON Web Token (JWT) Profile for Oauth 2.0 Authorization Grant based authentication", + "Oauth 2.0 Client Credentials Grant Authentication", + "SSH Public Key Authentication", + "Oauth 2.0 Authorization Code Flow", + "Google authentication", + "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" + ], + "type": "string" + }, + "description": { + "description": "Description of the schema.", + "type": "string" + }, + "displayName": { + "description": "Display name of the schema.", + "type": "string" + }, + "isDefault": { + "description": "Whether the auth schema is the default one.", + "type": "boolean" + } + }, + "type": "object" + }, "AuthorizationCodeLink": { "description": "This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow.", "id": "AuthorizationCodeLink", @@ -2628,6 +2802,10 @@ "description": "The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source.", "type": "string" }, + "clientSecret": { + "$ref": "Secret", + "description": "Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source." + }, "enablePkce": { "description": "Whether to enable PKCE for the auth code flow.", "type": "boolean" @@ -2868,6 +3046,10 @@ "$ref": "AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." }, + "authOverrideEnabled": { + "description": "Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.", + "type": "boolean" + }, "billingConfig": { "$ref": "BillingConfig", "description": "Output only. Billing config for the connection.", @@ -3272,6 +3454,10 @@ "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "ConnectorInfraConfig", "properties": { + "alwaysAllocateCpu": { + "description": "Indicates that the Cloud Run CPU should always be allocated.", + "type": "boolean" + }, "connectionRatelimitWindowSeconds": { "description": "The window used for ratelimiting runtime requests to connections.", "format": "int64", @@ -3309,6 +3495,14 @@ "description": "Indicate whether connector is being migrated to cloud run deployment model.", "type": "boolean" }, + "migrateTls": { + "description": "Indicate whether connector is being migrated to TLS.", + "type": "boolean" + }, + "provisionCloudSpanner": { + "description": "Indicate whether cloud spanner is required for connector job.", + "type": "boolean" + }, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3592,6 +3786,21 @@ "description": "Output only. The name of shared connector deployment.", "readOnly": true, "type": "string" + }, + "tlsMigrationState": { + "description": "Output only. Status of the TLS migration.", + "enum": [ + "TLS_MIGRATION_STATE_UNSPECIFIED", + "TLS_MIGRATION_NOT_STARTED", + "TLS_MIGRATION_COMPLETED" + ], + "enumDescriptions": [ + "TLS migration state is not specified.", + "TLS migration is in progress.", + "TLS migration is completed." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -4605,6 +4814,24 @@ }, "type": "object" }, + "FetchAuthSchemaResponse": { + "description": "Response message for Connectors.GetAuthSchema.", + "id": "FetchAuthSchemaResponse", + "properties": { + "authSchemas": { + "description": "List of AuthSchemas.", + "items": { + "$ref": "AuthSchema" + }, + "type": "array" + }, + "jsonSchema": { + "$ref": "JsonAuthSchema", + "description": "JSON schema of the AuthSchemas. This is only populated if the view is JSON_SCHEMA. The schema is in draft-07 format." + } + }, + "type": "object" + }, "Field": { "description": "Metadata of an entity field.", "id": "Field", @@ -5185,6 +5412,24 @@ }, "type": "object" }, + "JsonAuthSchema": { + "description": "JsonAuthSchema defines the JSON schema of all authentication types.", + "id": "JsonAuthSchema", + "properties": { + "$schema": { + "description": "JSON schema of the AuthSchemas.", + "type": "string" + }, + "oneOf": { + "description": "List of AuthObjects.", + "items": { + "$ref": "AuthObject" + }, + "type": "array" + } + }, + "type": "object" + }, "JsonSchema": { "description": "JsonSchema representation of schema metadata", "id": "JsonSchema", @@ -6180,6 +6425,28 @@ }, "type": "object" }, + "Oauth2AuthCodeFlowGoogleManaged": { + "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", + "id": "Oauth2AuthCodeFlowGoogleManaged", + "properties": { + "authCode": { + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", + "type": "string" + }, + "redirectUri": { + "description": "Optional. Redirect URI to be provided during the auth code exchange.", + "type": "string" + }, + "scopes": { + "description": "Required. Scopes the connection will request when the user performs the auth code flow.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Oauth2ClientCredentials": { "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", "id": "Oauth2ClientCredentials", diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index eb44085fd4..ac2e60fa84 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -512,7 +512,7 @@ } } }, - "revision": "20240624", + "revision": "20240904", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -703,7 +703,7 @@ "type": "object" }, "Critical": { - "description": "Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours.", + "description": "Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours.", "id": "Critical", "properties": { "peakHours": { @@ -1034,6 +1034,14 @@ "type": "string" }, "type": "array" + }, + "producerProjectIds": { + "description": "Output only. The CCAIP tenant project ids.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 5eb074f8b6..da15fa5174 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -284,8 +284,7 @@ ] }, "create": { - "deprecated": true, - "description": "Creates a conversation. Does not support audio transcription or DLP redaction. Use `conversations.upload` instead.", + "description": "Creates a conversation. Note that this method does not support audio transcription or redaction. Use `conversations.upload` instead.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/conversations", "httpMethod": "POST", "id": "contactcenterinsights.projects.locations.conversations.create", @@ -435,7 +434,7 @@ "type": "string" }, "pageSize": { - "description": "The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,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.", + "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" @@ -1531,7 +1530,7 @@ } } }, - "revision": "20240805", + "revision": "20240925", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2173,6 +2172,10 @@ ], "type": "string" }, + "metadataJson": { + "description": "Input only. JSON Metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insights' supported formats.", + "type": "string" + }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" @@ -4774,6 +4777,10 @@ ], "type": "string" }, + "metadataJson": { + "description": "Input only. JSON Metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insights' supported formats.", + "type": "string" + }, "name": { "description": "Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}", "type": "string" diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 63a2a61873..fd4e247cc8 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -14,7 +14,7 @@ "canonicalName": "Container", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/container-engine/", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2540,7 +2540,7 @@ } } }, - "revision": "20240806", + "revision": "20240912", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2594,6 +2594,10 @@ "$ref": "MaxPodsConstraint", "description": "The maximum number of pods per node which use this pod network." }, + "networkAttachment": { + "description": "The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.", + "type": "string" + }, "secondaryPodRange": { "description": "The name of the secondary range on the subnet which provides IP address for this pod range.", "type": "string" @@ -3147,6 +3151,10 @@ "description": "The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`.", "type": "string" }, + "compliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Enable/Disable Compliance Posture features for the cluster." + }, "conditions": { "description": "Which conditions caused the current cluster state.", "items": { @@ -3458,6 +3466,10 @@ "readOnly": true, "type": "string" }, + "userManagedKeysConfig": { + "$ref": "UserManagedKeysConfig", + "description": "The Custom keys configuration for the cluster." + }, "verticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." @@ -3565,6 +3577,10 @@ "$ref": "ClusterAutoscaling", "description": "Cluster-level autoscaling configuration." }, + "desiredCompliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Enable/Disable Compliance Posture features for the cluster." + }, "desiredContainerdConfig": { "$ref": "ContainerdConfig", "description": "The desired containerd config for the cluster." @@ -3821,6 +3837,10 @@ "removedAdditionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", "description": "The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument." + }, + "userManagedKeysConfig": { + "$ref": "UserManagedKeysConfig", + "description": "The Custom keys configuration for the cluster." } }, "type": "object" @@ -3857,6 +3877,45 @@ "properties": {}, "type": "object" }, + "CompliancePostureConfig": { + "description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", + "id": "CompliancePostureConfig", + "properties": { + "complianceStandards": { + "description": "List of enabled compliance standards.", + "items": { + "$ref": "ComplianceStandard" + }, + "type": "array" + }, + "mode": { + "description": "Defines the enablement mode for Compliance Posture.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value not specified.", + "Disables Compliance Posture features on the cluster.", + "Enables Compliance Posture features on the cluster." + ], + "type": "string" + } + }, + "type": "object" + }, + "ComplianceStandard": { + "description": "Defines the details of a compliance standard.", + "id": "ComplianceStandard", + "properties": { + "standard": { + "description": "Name of the compliance standard.", + "type": "string" + } + }, + "type": "object" + }, "ConfidentialNodes": { "description": "ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.", "id": "ConfidentialNodes", @@ -4351,7 +4410,7 @@ "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", - "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header." + "description": "For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header." }, "keys": { "description": "The public component of the keys used by the cluster to sign token requests.", @@ -4369,7 +4428,7 @@ "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", - "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header." + "description": "For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header." }, "claims_supported": { "description": "Supported claims.", @@ -4845,7 +4904,9 @@ "WORKLOADS", "APISERVER", "SCHEDULER", - "CONTROLLER_MANAGER" + "CONTROLLER_MANAGER", + "KCP_SSHD", + "KCP_CONNECTION" ], "enumDescriptions": [ "Default value. This shouldn't be used.", @@ -4853,7 +4914,9 @@ "workloads", "kube-apiserver", "kube-scheduler", - "kube-controller-manager" + "kube-controller-manager", + "kcp-sshd", + "kcp connection logs" ], "type": "string" }, @@ -5370,6 +5433,21 @@ "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, + "effectiveCgroupMode": { + "description": "Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.", + "enum": [ + "EFFECTIVE_CGROUP_MODE_UNSPECIFIED", + "EFFECTIVE_CGROUP_MODE_V1", + "EFFECTIVE_CGROUP_MODE_V2" + ], + "enumDescriptions": [ + "EFFECTIVE_CGROUP_MODE_UNSPECIFIED means the cgroup configuration for the node pool is unspecified, i.e. the node pool is a Windows node pool.", + "CGROUP_MODE_V1 means the node pool is configured to use cgroupv1 for the cgroup configuration.", + "CGROUP_MODE_V2 means the node pool is configured to use cgroupv2 for the cgroup configuration." + ], + "readOnly": true, + "type": "string" + }, "enableConfidentialStorage": { "description": "Optional. Reserved for future use.", "type": "boolean" @@ -7838,6 +7916,51 @@ }, "type": "object" }, + "UserManagedKeysConfig": { + "description": "UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.", + "id": "UserManagedKeysConfig", + "properties": { + "aggregationCa": { + "description": "The Certificate Authority Service caPool to use for the aggregation CA in this cluster.", + "type": "string" + }, + "clusterCa": { + "description": "The Certificate Authority Service caPool to use for the cluster CA in this cluster.", + "type": "string" + }, + "controlPlaneDiskEncryptionKey": { + "description": "The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.", + "type": "string" + }, + "etcdApiCa": { + "description": "Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.", + "type": "string" + }, + "etcdPeerCa": { + "description": "Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.", + "type": "string" + }, + "gkeopsEtcdBackupEncryptionKey": { + "description": "Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.", + "type": "string" + }, + "serviceAccountSigningKeys": { + "description": "The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceAccountVerificationKeys": { + "description": "The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VerticalPodAutoscaling": { "description": "VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.", "id": "VerticalPodAutoscaling", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index f4936d21bc..fbdb884a8f 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -14,7 +14,7 @@ "canonicalName": "Container", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/container-engine/", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240806", + "revision": "20240912", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2625,6 +2625,10 @@ "$ref": "MaxPodsConstraint", "description": "The maximum number of pods per node which use this pod network." }, + "networkAttachment": { + "description": "The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.", + "type": "string" + }, "secondaryPodRange": { "description": "The name of the secondary range on the subnet which provides IP address for this pod range.", "type": "string" @@ -3598,6 +3602,10 @@ "readOnly": true, "type": "string" }, + "userManagedKeysConfig": { + "$ref": "UserManagedKeysConfig", + "description": "The Custom keys configuration for the cluster." + }, "verticalPodAutoscaling": { "$ref": "VerticalPodAutoscaling", "description": "Cluster-level Vertical Pod Autoscaling configuration." @@ -3740,6 +3748,10 @@ "$ref": "ClusterTelemetry", "description": "The desired telemetry integration for the cluster." }, + "desiredCompliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Enable/Disable Compliance Posture features for the cluster." + }, "desiredContainerdConfig": { "$ref": "ContainerdConfig", "description": "The desired containerd config for the cluster." @@ -4030,6 +4042,10 @@ "removedAdditionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", "description": "The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument." + }, + "userManagedKeysConfig": { + "$ref": "UserManagedKeysConfig", + "description": "The Custom keys configuration for the cluster." } }, "type": "object" @@ -4633,7 +4649,7 @@ "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", - "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header." + "description": "For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header." }, "keys": { "description": "The public component of the keys used by the cluster to sign token requests.", @@ -4651,7 +4667,7 @@ "properties": { "cacheHeader": { "$ref": "HttpCacheControlResponseHeader", - "description": "OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header." + "description": "For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header." }, "claims_supported": { "description": "Supported claims.", @@ -5240,7 +5256,9 @@ "WORKLOADS", "APISERVER", "SCHEDULER", - "CONTROLLER_MANAGER" + "CONTROLLER_MANAGER", + "KCP_SSHD", + "KCP_CONNECTION" ], "enumDescriptions": [ "Default value. This shouldn't be used.", @@ -5248,7 +5266,9 @@ "workloads", "kube-apiserver", "kube-scheduler", - "kube-controller-manager" + "kube-controller-manager", + "kcp-sshd", + "kcp connection logs" ], "type": "string" }, @@ -5802,6 +5822,21 @@ "description": "Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'", "type": "string" }, + "effectiveCgroupMode": { + "description": "Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.", + "enum": [ + "EFFECTIVE_CGROUP_MODE_UNSPECIFIED", + "EFFECTIVE_CGROUP_MODE_V1", + "EFFECTIVE_CGROUP_MODE_V2" + ], + "enumDescriptions": [ + "EFFECTIVE_CGROUP_MODE_UNSPECIFIED means the cgroup configuration for the node pool is unspecified, i.e. the node pool is a Windows node pool.", + "CGROUP_MODE_V1 means the node pool is configured to use cgroupv1 for the cgroup configuration.", + "CGROUP_MODE_V2 means the node pool is configured to use cgroupv2 for the cgroup configuration." + ], + "readOnly": true, + "type": "string" + }, "enableConfidentialStorage": { "description": "Optional. Reserved for future use.", "type": "boolean" @@ -8394,6 +8429,51 @@ }, "type": "object" }, + "UserManagedKeysConfig": { + "description": "UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.", + "id": "UserManagedKeysConfig", + "properties": { + "aggregationCa": { + "description": "The Certificate Authority Service caPool to use for the aggregation CA in this cluster.", + "type": "string" + }, + "clusterCa": { + "description": "The Certificate Authority Service caPool to use for the cluster CA in this cluster.", + "type": "string" + }, + "controlPlaneDiskEncryptionKey": { + "description": "The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.", + "type": "string" + }, + "etcdApiCa": { + "description": "Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.", + "type": "string" + }, + "etcdPeerCa": { + "description": "Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.", + "type": "string" + }, + "gkeopsEtcdBackupEncryptionKey": { + "description": "Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.", + "type": "string" + }, + "serviceAccountSigningKeys": { + "description": "The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}`", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceAccountVerificationKeys": { + "description": "The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "VerticalPodAutoscaling": { "description": "VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.", "id": "VerticalPodAutoscaling", diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index b03a70b33f..c35c7fe34e 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -1655,7 +1655,7 @@ } } }, - "revision": "20240816", + "revision": "20240924", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -3150,11 +3150,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 24a21e16a4..6765f48e86 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1420,7 +1420,7 @@ } } }, - "revision": "20240816", + "revision": "20240924", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2721,11 +2721,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index a03ac1611f..be15eefcf3 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -409,6 +409,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:getIamPolicy", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.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/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists notes for the specified project.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes", @@ -483,6 +511,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:setIamPolicy", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.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/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}:testIamPermissions", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.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/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -641,6 +725,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getIamPolicy": { + "description": "Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:getIamPolicy", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.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/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getNotes": { "description": "Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}/notes", @@ -770,6 +882,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:setIamPolicy", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.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/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}:testIamPermissions", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.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/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1543,7 +1711,7 @@ } } }, - "revision": "20240816", + "revision": "20240924", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2938,11 +3106,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, diff --git a/discovery/css-v1.json b/discovery/css-v1.json index 20fdf7e4d9..73db2c3792 100644 --- a/discovery/css-v1.json +++ b/discovery/css-v1.json @@ -472,7 +472,7 @@ } } }, - "revision": "20240719", + "revision": "20240909", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -691,6 +691,10 @@ "description": "Condition of the headline offer.", "type": "string" }, + "headlineOfferInstallment": { + "$ref": "HeadlineOfferInstallment", + "description": "Number and amount of installments to pay for an item." + }, "headlineOfferLink": { "description": "Link to the headline offer.", "type": "string" @@ -707,6 +711,10 @@ "$ref": "Price", "description": "Headline Price of the aggregate offer." }, + "headlineOfferSubscriptionCost": { + "$ref": "HeadlineOfferSubscriptionCost", + "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract." + }, "highPrice": { "$ref": "Price", "description": "High Price of the aggregate offer." @@ -1022,6 +1030,56 @@ "properties": {}, "type": "object" }, + "HeadlineOfferInstallment": { + "description": "A message that represents installment.", + "id": "HeadlineOfferInstallment", + "properties": { + "amount": { + "$ref": "Price", + "description": "The amount the buyer has to pay per month." + }, + "downpayment": { + "$ref": "Price", + "description": "The up-front down payment amount the buyer has to pay." + }, + "months": { + "description": "The number of installments the buyer has to pay.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "HeadlineOfferSubscriptionCost": { + "description": "The SubscriptionCost of the product.", + "id": "HeadlineOfferSubscriptionCost", + "properties": { + "amount": { + "$ref": "Price", + "description": "The amount the buyer has to pay per subscription period." + }, + "period": { + "description": "The type of subscription period. Supported values are: * \"`month`\" * \"`year`\"", + "enum": [ + "SUBSCRIPTION_PERIOD_UNSPECIFIED", + "MONTH", + "YEAR" + ], + "enumDescriptions": [ + "Indicates that the subscription period is unspecified.", + "Indicates that the subscription period is month.", + "Indicates that the subscription period is year." + ], + "type": "string" + }, + "periodLength": { + "description": "The number of subscription periods the buyer has to pay.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "ItemLevelIssue": { "description": "The ItemLevelIssue of the product status.", "id": "ItemLevelIssue", diff --git a/discovery/datalineage-v1.json b/discovery/datalineage-v1.json index bde88540e2..8f1a57263e 100644 --- a/discovery/datalineage-v1.json +++ b/discovery/datalineage-v1.json @@ -798,7 +798,7 @@ } } }, - "revision": "20230908", + "revision": "20240902", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { @@ -1060,7 +1060,8 @@ "DATA_FUSION", "COMPOSER", "LOOKER_STUDIO", - "DATAPROC" + "DATAPROC", + "VERTEX_AI" ], "enumDescriptions": [ "Source is Unspecified", @@ -1069,7 +1070,8 @@ "Data Fusion", "Composer", "Looker Studio", - "Dataproc" + "Dataproc", + "Vertex AI" ], "type": "string" } diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index b61857df47..5a05010a0e 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -2218,7 +2218,7 @@ } } }, - "revision": "20240826", + "revision": "20240930", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2245,12 +2245,14 @@ "enum": [ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDescriptions": [ "This is an unknown database version.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2389,6 +2391,17 @@ }, "type": "object" }, + "AuthorizedNetwork": { + "description": "AuthorizedNetwork contains metadata for an authorized network.", + "id": "AuthorizedNetwork", + "properties": { + "cidrRange": { + "description": "Optional. CIDR range for one authorzied network of the instance.", + "type": "string" + } + }, + "type": "object" + }, "BackgroundJobLogEntry": { "description": "Execution log of a background job.", "id": "BackgroundJobLogEntry", @@ -2473,6 +2486,21 @@ }, "type": "object" }, + "BinaryLogParser": { + "description": "Configuration to use Binary Log Parser CDC technique.", + "id": "BinaryLogParser", + "properties": { + "logFileDirectories": { + "$ref": "LogFileDirectories", + "description": "Use Oracle directories." + }, + "oracleAsmLogFileAccess": { + "$ref": "OracleAsmLogFileAccess", + "description": "Use Oracle ASM." + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -2607,7 +2635,7 @@ "type": "object" }, "databaseVersion": { - "description": "The database engine type and version.", + "description": "The database engine type and version. Deprecated. Use database_version_name instead.", "enum": [ "SQL_DATABASE_VERSION_UNSPECIFIED", "MYSQL_5_6", @@ -2664,6 +2692,10 @@ ], "type": "string" }, + "databaseVersionName": { + "description": "Optional. The database engine type and version name.", + "type": "string" + }, "edition": { "description": "Optional. The edition of the given Cloud SQL instance.", "enum": [ @@ -4065,6 +4097,28 @@ }, "type": "object" }, + "InstanceNetworkConfig": { + "description": "Metadata related to instance level network configuration.", + "id": "InstanceNetworkConfig", + "properties": { + "authorizedExternalNetworks": { + "description": "Optional. A list of external network authorized to access this instance.", + "items": { + "$ref": "AuthorizedNetwork" + }, + "type": "array" + }, + "enableOutboundPublicIp": { + "description": "Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet.", + "type": "boolean" + }, + "enablePublicIp": { + "description": "Optional. Enabling public ip for the instance.", + "type": "boolean" + } + }, + "type": "object" + }, "IntComparisonFilter": { "description": "Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue", "id": "IntComparisonFilter", @@ -4283,6 +4337,27 @@ }, "type": "object" }, + "LogFileDirectories": { + "description": "Configuration to specify the Oracle directories to access the log files.", + "id": "LogFileDirectories", + "properties": { + "archivedLogDirectory": { + "description": "Required. Oracle directory for archived logs.", + "type": "string" + }, + "onlineLogDirectory": { + "description": "Required. Oracle directory for online logs.", + "type": "string" + } + }, + "type": "object" + }, + "LogMiner": { + "description": "Configuration to use LogMiner CDC method.", + "id": "LogMiner", + "properties": {}, + "type": "object" + }, "MachineConfig": { "description": "MachineConfig describes the configuration of a machine.", "id": "MachineConfig", @@ -4563,6 +4638,10 @@ "description": "The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.", "type": "string" }, + "oracleToPostgresConfig": { + "$ref": "OracleToPostgresConfig", + "description": "Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations." + }, "performanceConfig": { "$ref": "PerformanceConfig", "description": "Optional. Data dump parallelism settings used by the migration." @@ -4952,6 +5031,12 @@ }, "type": "object" }, + "OracleAsmLogFileAccess": { + "description": "Configuration to use Oracle ASM to access the log files.", + "id": "OracleAsmLogFileAccess", + "properties": {}, + "type": "object" + }, "OracleConnectionProfile": { "description": "Specifies connection parameters required specifically for Oracle databases.", "id": "OracleConnectionProfile", @@ -5005,6 +5090,55 @@ }, "type": "object" }, + "OracleSourceConfig": { + "description": "Configuration for Oracle as a source in a migration.", + "id": "OracleSourceConfig", + "properties": { + "binaryLogParser": { + "$ref": "BinaryLogParser", + "description": "Use Binary Log Parser." + }, + "cdcStartPosition": { + "description": "Optional. The schema change number (SCN) to start CDC data migration from.", + "format": "int64", + "type": "string" + }, + "logMiner": { + "$ref": "LogMiner", + "description": "Use LogMiner." + }, + "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" + }, + "OracleToPostgresConfig": { + "description": "Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations.", + "id": "OracleToPostgresConfig", + "properties": { + "oracleSourceConfig": { + "$ref": "OracleSourceConfig", + "description": "Optional. Configuration for Oracle source." + }, + "postgresDestinationConfig": { + "$ref": "PostgresDestinationConfig", + "description": "Optional. Configuration for Postgres destination." + } + }, + "type": "object" + }, "PackageEntity": { "description": "Package's parent is a schema.", "id": "PackageEntity", @@ -5173,6 +5307,23 @@ }, "type": "object" }, + "PostgresDestinationConfig": { + "description": "Configuration for Postgres as a destination in a migration.", + "id": "PostgresDestinationConfig", + "properties": { + "maxConcurrentConnections": { + "description": "Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.", + "format": "int32", + "type": "integer" + }, + "transactionTimeout": { + "description": "Optional. Timeout for data migration transactions.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "PrimaryInstanceSettings": { "description": "Settings for the cluster's primary instance", "id": "PrimaryInstanceSettings", @@ -5188,6 +5339,10 @@ "description": "Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression \"[a-z0-9-]+\".", "type": "string" }, + "instanceNetworkConfig": { + "$ref": "InstanceNetworkConfig", + "description": "Optional. Metadata related to instance level network configuration." + }, "labels": { "additionalProperties": { "type": "string" @@ -5199,6 +5354,14 @@ "$ref": "MachineConfig", "description": "Configuration for the machines that host the underlying database engine." }, + "outboundPublicIpAddresses": { + "description": "Output only. All outbound public IP addresses configured for the instance.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "privateIp": { "description": "Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application.", "readOnly": true, diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 68c7a723f2..32ecefda8f 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -398,7 +398,7 @@ ] }, "lookupEntry": { - "description": "Looks up a single Entry by name using the permission on the source system.", + "description": "Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", "httpMethod": "GET", "id": "dataplex.projects.locations.lookupEntry", @@ -2369,7 +2369,7 @@ ] }, "get": { - "description": "Gets an Entry.", + "description": "Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.get", @@ -2480,7 +2480,7 @@ "type": "boolean" }, "aspectKeys": { - "description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", + "description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", "location": "query", "repeated": true, "type": "string" @@ -5997,397 +5997,9 @@ } } }, - "revision": "20240820", + "revision": "20240925", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { - "CloudReliabilityZicyWs3DataplaneProtosAssetLocation": { - "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", - "id": "CloudReliabilityZicyWs3DataplaneProtosAssetLocation", - "properties": { - "ccfeRmsPath": { - "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", - "type": "string" - }, - "expected": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations", - "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." - }, - "extraParameters": { - "description": "Defines extra parameters required for specific asset types.", - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosExtraParameter" - }, - "type": "array" - }, - "locationData": { - "description": "Contains all kinds of physical location definitions for this asset.", - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosLocationData" - }, - "type": "array" - }, - "parentAsset": { - "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations": { - "id": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations", - "properties": { - "requirementOverride": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride", - "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." - }, - "ziOrgPolicy": { - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "ziRegionPolicy": { - "enum": [ - "ZI_REGION_POLICY_UNSPECIFIED", - "ZI_REGION_POLICY_UNKNOWN", - "ZI_REGION_POLICY_NOT_SET", - "ZI_REGION_POLICY_FAIL_OPEN", - "ZI_REGION_POLICY_FAIL_CLOSED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "ziRegionState": { - "enum": [ - "ZI_REGION_UNSPECIFIED", - "ZI_REGION_UNKNOWN", - "ZI_REGION_NOT_ENABLED", - "ZI_REGION_ENABLED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zoneIsolation": { - "deprecated": true, - "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "zoneSeparation": { - "deprecated": true, - "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zsOrgPolicy": { - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - }, - "zsRegionState": { - "enum": [ - "ZS_REGION_UNSPECIFIED", - "ZS_REGION_UNKNOWN", - "ZS_REGION_NOT_ENABLED", - "ZS_REGION_ENABLED" - ], - "enumDescriptions": [ - "", - "To be used if tracking of the asset ZS-bit is not available", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride": { - "id": "CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride", - "properties": { - "ziOverride": { - "enum": [ - "ZI_UNSPECIFIED", - "ZI_UNKNOWN", - "ZI_NOT_REQUIRED", - "ZI_PREFERRED", - "ZI_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "", - "" - ], - "type": "string" - }, - "zsOverride": { - "enum": [ - "ZS_UNSPECIFIED", - "ZS_UNKNOWN", - "ZS_NOT_REQUIRED", - "ZS_REQUIRED" - ], - "enumDescriptions": [ - "", - "To be used if tracking is not available", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation": { - "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", - "id": "CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation", - "properties": { - "policyId": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosCloudAsset": { - "id": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset", - "properties": { - "assetName": { - "type": "string" - }, - "assetType": { - "type": "string" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition": { - "id": "CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition", - "properties": { - "childAsset": { - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosCloudAsset" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment": { - "id": "CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment", - "properties": { - "location": { - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosLocationAssignment" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosExtraParameter": { - "description": "Defines parameters that should only be used for specific asset types.", - "id": "CloudReliabilityZicyWs3DataplaneProtosExtraParameter", - "properties": { - "regionalMigDistributionPolicy": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy", - "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosLocationAssignment": { - "id": "CloudReliabilityZicyWs3DataplaneProtosLocationAssignment", - "properties": { - "location": { - "type": "string" - }, - "locationType": { - "enum": [ - "UNSPECIFIED", - "CLUSTER", - "POP", - "CLOUD_ZONE", - "CLOUD_REGION", - "MULTI_REGION_GEO", - "MULTI_REGION_JURISDICTION", - "GLOBAL", - "OTHER" - ], - "enumDescriptions": [ - "", - "1-10: Physical failure domains.", - "", - "11-20: Logical failure domains.", - "", - "", - "", - "", - "" - ], - "type": "string" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosLocationData": { - "id": "CloudReliabilityZicyWs3DataplaneProtosLocationData", - "properties": { - "blobstoreLocation": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation" - }, - "childAssetLocation": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition" - }, - "directLocation": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment" - }, - "gcpProjectProxy": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy" - }, - "placerLocation": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosPlacerLocation" - }, - "spannerLocation": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosSpannerLocation" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosPlacerLocation": { - "description": "Message describing that the location of the customer resource is tied to placer allocations", - "id": "CloudReliabilityZicyWs3DataplaneProtosPlacerLocation", - "properties": { - "placerConfig": { - "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", - "type": "string" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy": { - "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", - "id": "CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy", - "properties": { - "targetShape": { - "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", - "format": "int32", - "type": "integer" - }, - "zones": { - "description": "Cloud zones used by regional MIG to create instances.", - "items": { - "$ref": "CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosSpannerLocation": { - "id": "CloudReliabilityZicyWs3DataplaneProtosSpannerLocation", - "properties": { - "backupName": { - "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", - "items": { - "type": "string" - }, - "type": "array" - }, - "dbName": { - "description": "Set of databases used by the resource in format /span//", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy": { - "id": "CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy", - "properties": { - "projectNumbers": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration": { - "id": "CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration", - "properties": { - "zone": { - "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", @@ -6703,6 +6315,21 @@ "readOnly": true, "type": "string" }, + "transferStatus": { + "description": "Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.", + "enum": [ + "TRANSFER_STATUS_UNSPECIFIED", + "TRANSFER_STATUS_MIGRATED", + "TRANSFER_STATUS_TRANSFERRED" + ], + "enumDescriptions": [ + "The default value. It is set for resources that were not subject for migration from Data Catalog service.", + "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", + "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." + ], + "readOnly": true, + "type": "string" + }, "uid": { "description": "Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.", "readOnly": true, @@ -9008,6 +8635,10 @@ "description": "The data location associated with the event.", "type": "string" }, + "datascanId": { + "description": "The id of the associated datascan for standalone discovery.", + "type": "string" + }, "entity": { "$ref": "GoogleCloudDataplexV1DiscoveryEventEntityDetails", "description": "Details about the entity associated with the event." @@ -9024,6 +8655,10 @@ "$ref": "GoogleCloudDataplexV1DiscoveryEventPartitionDetails", "description": "Details about the partition associated with the event." }, + "table": { + "$ref": "GoogleCloudDataplexV1DiscoveryEventTableDetails", + "description": "Details about the BigQuery table publishing associated with the event." + }, "type": { "description": "The type of the event being logged.", "enum": [ @@ -9141,6 +8776,33 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DiscoveryEventTableDetails": { + "description": "Details about the published table.", + "id": "GoogleCloudDataplexV1DiscoveryEventTableDetails", + "properties": { + "table": { + "description": "The fully-qualified resource name of the table resource.", + "type": "string" + }, + "type": { + "description": "The type of the table resource.", + "enum": [ + "TABLE_TYPE_UNSPECIFIED", + "EXTERNAL_TABLE", + "BIGLAKE_TABLE", + "OBJECT_TABLE" + ], + "enumDescriptions": [ + "An unspecified table type.", + "External table type.", + "BigLake table type.", + "Object table type for unstructured data." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Entity": { "description": "Represents tables and fileset metadata contained within a zone.", "id": "GoogleCloudDataplexV1Entity", @@ -9363,6 +9025,21 @@ "readOnly": true, "type": "string" }, + "transferStatus": { + "description": "Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.", + "enum": [ + "TRANSFER_STATUS_UNSPECIFIED", + "TRANSFER_STATUS_MIGRATED", + "TRANSFER_STATUS_TRANSFERRED" + ], + "enumDescriptions": [ + "The default value. It is set for resources that were not subject for migration from Data Catalog service.", + "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", + "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." + ], + "readOnly": true, + "type": "string" + }, "uid": { "description": "Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.", "readOnly": true, @@ -11863,7 +11540,7 @@ "type": "string" }, "sqlScriptFile": { - "description": "A reference to a query file. This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key=\"value\";).", + "description": "A reference to a query file. This should be the Cloud Storage URI of the query file. The execution args are used to declare a set of script variables (set key=\"value\";).", "type": "string" } }, diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 9131def83a..ad05dc35c5 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -31,6 +31,61 @@ "endpointUrl": "https://dataproc.us-central1.rep.googleapis.com/", "location": "us-central1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.us-west8.rep.googleapis.com/", + "location": "us-west8" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataproc.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", @@ -525,795 +580,1094 @@ "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": "dataproc.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", - "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": "dataproc.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": "dataproc.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": "dataproc.projects.locations.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" + }, + "resources": { + "sparkApplications": { + "methods": { + "access": { + "description": "Obtain high level information corresponding to a single Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:access", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.access", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:access", + "response": { + "$ref": "AccessSparkApplicationResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations$", - "required": true, - "type": "string" + "accessEnvironmentInfo": { + "description": "Obtain environment details for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessEnvironmentInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessEnvironmentInfo", + "response": { + "$ref": "AccessSparkApplicationEnvironmentInfoResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "accessJob": { + "description": "Obtain data corresponding to a spark job for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessJob", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessJob", + "parameterOrder": [ + "name" + ], + "parameters": { + "jobId": { + "description": "Required. Job ID to fetch data for.", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessJob", + "response": { + "$ref": "AccessSparkApplicationJobResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "ListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "sessionTemplates": { - "methods": { - "create": { - "description": "Create a session template synchronously.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates", - "httpMethod": "POST", - "id": "dataproc.projects.locations.sessionTemplates.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this session template will be created.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/sessionTemplates", - "request": { - "$ref": "SessionTemplate" - }, - "response": { - "$ref": "SessionTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a session template.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", - "httpMethod": "DELETE", - "id": "dataproc.projects.locations.sessionTemplates.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session template resource to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the resource representation for a session template.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", - "httpMethod": "GET", - "id": "dataproc.projects.locations.sessionTemplates.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session template to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "SessionTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists session templates.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates", - "httpMethod": "GET", - "id": "dataproc.projects.locations.sessionTemplates.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ...", - "location": "query", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" + "accessSqlPlan": { + "description": "Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessSqlPlan", + "parameterOrder": [ + "name" + ], + "parameters": { + "executionId": { + "description": "Required. Execution ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessSqlPlan", + "response": { + "$ref": "AccessSparkApplicationSqlSparkPlanGraphResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.", - "location": "query", - "type": "string" + "accessSqlQuery": { + "description": "Obtain data corresponding to a particular SQL Query for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessSqlQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "details": { + "description": "Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.", + "location": "query", + "type": "boolean" + }, + "executionId": { + "description": "Required. Execution ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "planDescription": { + "description": "Optional. Enables/ disables physical plan description on demand", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:accessSqlQuery", + "response": { + "$ref": "AccessSparkApplicationSqlQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The parent that owns this collection of session templates.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/sessionTemplates", - "response": { - "$ref": "ListSessionTemplatesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "description": "Updates the session template synchronously.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", - "httpMethod": "PATCH", - "id": "dataproc.projects.locations.sessionTemplates.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the session template.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "SessionTemplate" - }, - "response": { - "$ref": "SessionTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "sessions": { - "methods": { - "create": { - "description": "Create an interactive session asynchronously.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions", - "httpMethod": "POST", - "id": "dataproc.projects.locations.sessions.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The parent resource where this session will be created.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "accessStageAttempt": { + "description": "Obtain data corresponding to a spark stage attempt for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessStageAttempt", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessStageAttempt", + "response": { + "$ref": "AccessSparkApplicationStageAttemptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", - "type": "string" + "accessStageRddGraph": { + "description": "Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.accessStageRddGraph", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessStageRddGraph", + "response": { + "$ref": "AccessSparkApplicationStageRddOperationGraphResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "sessionId": { - "description": "Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/sessions", - "request": { - "$ref": "Session" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}", - "httpMethod": "DELETE", - "id": "dataproc.projects.locations.sessions.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session resource to delete.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" + "search": { + "description": "Obtain high level information and list of Spark Applications corresponding to a batch", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications:search", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "applicationStatus": { + "description": "Optional. Search only applications in the chosen state.", + "enum": [ + "APPLICATION_STATUS_UNSPECIFIED", + "APPLICATION_STATUS_RUNNING", + "APPLICATION_STATUS_COMPLETED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "maxEndTime": { + "description": "Optional. Latest end timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "maxTime": { + "description": "Optional. Latest start timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "minEndTime": { + "description": "Optional. Earliest end timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "minTime": { + "description": "Optional. Earliest start timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSparkApplications call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sparkApplications:search", + "response": { + "$ref": "SearchSparkApplicationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the resource representation for an interactive session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}", - "httpMethod": "GET", - "id": "dataproc.projects.locations.sessions.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session to retrieve.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Session" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists interactive sessions.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions", - "httpMethod": "GET", - "id": "dataproc.projects.locations.sessions.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "filter": { - "description": "Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < \"2023-01-01T00:00:00Z\" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.", - "location": "query", - "type": "string" + "searchExecutorStageSummary": { + "description": "Obtain executor summary with respect to a spark stage attempt.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchExecutorStageSummary", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchExecutorStageSummary", + "response": { + "$ref": "SearchSparkApplicationExecutorStageSummaryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.", - "format": "int32", - "location": "query", - "type": "integer" + "searchExecutors": { + "description": "Obtain data corresponding to executors for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchExecutors", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchExecutors", + "parameterOrder": [ + "name" + ], + "parameters": { + "executorStatus": { + "description": "Optional. Filter to select whether active/ dead or all executors should be selected.", + "enum": [ + "EXECUTOR_STATUS_UNSPECIFIED", + "EXECUTOR_STATUS_ACTIVE", + "EXECUTOR_STATUS_DEAD" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchExecutors", + "response": { + "$ref": "SearchSparkApplicationExecutorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.", - "location": "query", - "type": "string" + "searchJobs": { + "description": "Obtain list of spark jobs corresponding to a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchJobs", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchJobs", + "parameterOrder": [ + "name" + ], + "parameters": { + "jobStatus": { + "description": "Optional. List only jobs in the specific state.", + "enum": [ + "JOB_EXECUTION_STATUS_UNSPECIFIED", + "JOB_EXECUTION_STATUS_RUNNING", + "JOB_EXECUTION_STATUS_SUCCEEDED", + "JOB_EXECUTION_STATUS_FAILED", + "JOB_EXECUTION_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSparkApplicationJobs call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchJobs", + "response": { + "$ref": "SearchSparkApplicationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "parent": { - "description": "Required. The parent, which owns this collection of sessions.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/sessions", - "response": { - "$ref": "ListSessionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "terminate": { - "description": "Terminates the interactive session.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:terminate", - "httpMethod": "POST", - "id": "dataproc.projects.locations.sessions.terminate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the session resource to terminate.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:terminate", - "request": { - "$ref": "TerminateSessionRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "workflowTemplates": { - "methods": { - "create": { - "description": "Creates new workflow template.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/workflowTemplates", - "request": { - "$ref": "WorkflowTemplate" - }, - "response": { - "$ref": "WorkflowTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a workflow template. It does not cancel in-progress workflows.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "DELETE", - "id": "dataproc.projects.locations.workflowTemplates.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", - "required": true, - "type": "string" + "searchSqlQueries": { + "description": "Obtain data corresponding to SQL Queries for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchSqlQueries", + "parameterOrder": [ + "name" + ], + "parameters": { + "details": { + "description": "Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "planDescription": { + "description": "Optional. Enables/ disables physical plan description on demand", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:searchSqlQueries", + "response": { + "$ref": "SearchSparkApplicationSqlQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "version": { - "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", - "format": "int32", - "location": "query", - "type": "integer" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "GET", - "id": "dataproc.projects.locations.workflowTemplates.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", - "required": true, - "type": "string" + "searchStageAttemptTasks": { + "description": "Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchStageAttemptTasks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous ListSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "sortRuntime": { + "description": "Optional. Sort the tasks by runtime.", + "location": "query", + "type": "boolean" + }, + "stageAttemptId": { + "description": "Optional. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Optional. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "taskStatus": { + "description": "Optional. List only tasks in the state.", + "enum": [ + "TASK_STATUS_UNSPECIFIED", + "TASK_STATUS_RUNNING", + "TASK_STATUS_SUCCESS", + "TASK_STATUS_FAILED", + "TASK_STATUS_KILLED", + "TASK_STATUS_PENDING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStageAttemptTasks", + "response": { + "$ref": "SearchSparkApplicationStageAttemptTasksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "version": { - "description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.", - "format": "int32", - "location": "query", - "type": "integer" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "WorkflowTemplate" - }, - "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}/workflowTemplates/{workflowTemplatesId}:getIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.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/[^/]+/workflowTemplates/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "instantiate": { - "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.instantiate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:instantiate", - "request": { - "$ref": "InstantiateWorkflowTemplateRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "instantiateInline": { - "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.instantiateInline", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" + "searchStageAttempts": { + "description": "Obtain data corresponding to a spark stage attempts for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchStageAttempts", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageId": { + "description": "Required. Stage ID for which attempts are to be fetched", + "format": "int64", + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStageAttempts", + "response": { + "$ref": "SearchSparkApplicationStageAttemptsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "requestId": { - "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1/{+parent}/workflowTemplates:instantiateInline", - "request": { - "$ref": "WorkflowTemplate" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists workflows that match the specified filter in the request.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates", - "httpMethod": "GET", - "id": "dataproc.projects.locations.workflowTemplates.list", + "searchStages": { + "description": "Obtain data corresponding to stages for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:searchStages", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.searchStages", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous FetchSparkApplicationStagesList call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageStatus": { + "description": "Optional. List only stages in the given state.", + "enum": [ + "STAGE_STATUS_UNSPECIFIED", + "STAGE_STATUS_ACTIVE", + "STAGE_STATUS_COMPLETE", + "STAGE_STATUS_FAILED", + "STAGE_STATUS_PENDING", + "STAGE_STATUS_SKIPPED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStages", + "response": { + "$ref": "SearchSparkApplicationStagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeExecutors": { + "description": "Obtain summary of Executor Summary for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.summarizeExecutors", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeExecutors", + "response": { + "$ref": "SummarizeSparkApplicationExecutorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeJobs": { + "description": "Obtain summary of Jobs for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeJobs", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.summarizeJobs", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeJobs", + "response": { + "$ref": "SummarizeSparkApplicationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeStageAttemptTasks": { + "description": "Obtain summary of Tasks for a Spark Application Stage Attempt", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.summarizeStageAttemptTasks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeStageAttemptTasks", + "response": { + "$ref": "SummarizeSparkApplicationStageAttemptTasksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeStages": { + "description": "Obtain summary of Stages for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:summarizeStages", + "httpMethod": "GET", + "id": "dataproc.projects.locations.batches.sparkApplications.summarizeStages", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the batch to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeStages", + "response": { + "$ref": "SummarizeSparkApplicationStagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write wrapper objects from dataplane to spanner", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/batches/{batchesId}/sparkApplications/{sparkApplicationsId}:write", + "httpMethod": "POST", + "id": "dataproc.projects.locations.batches.sparkApplications.write", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the spark application to write data about in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/batches/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:write", + "request": { + "$ref": "WriteSparkApplicationContextRequest" + }, + "response": { + "$ref": "WriteSparkApplicationContextResponse" + }, + "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": "dataproc.projects.locations.operations.cancel", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "pageSize": { - "description": "Optional. The maximum number of results to return in each response.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "name": { + "description": "The name of the operation resource to be cancelled.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/workflowTemplates", + "path": "v1/{+name}:cancel", "response": { - "$ref": "ListWorkflowTemplatesResponse" + "$ref": "Empty" }, "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}/workflowTemplates/{workflowTemplatesId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.setIamPolicy", + "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": "dataproc.projects.locations.operations.delete", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource to be deleted.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "Policy" + "$ref": "Empty" }, "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}/workflowTemplates/{workflowTemplatesId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataproc.projects.locations.workflowTemplates.testIamPermissions", + "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": "dataproc.projects.locations.operations.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "update": { - "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "PUT", - "id": "dataproc.projects.locations.workflowTemplates.update", + "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": "dataproc.projects.locations.operations.list", "parameterOrder": [ "name" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, "name": { - "description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/operations$", "required": true, "type": "string" - } - }, - "path": "v1/{+name}", - "request": { - "$ref": "WorkflowTemplate" - }, - "response": { - "$ref": "WorkflowTemplate" - }, + }, + "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}", + "response": { + "$ref": "ListOperationsResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } - }, - "regions": { - "resources": { - "autoscalingPolicies": { + }, + "sessionTemplates": { "methods": { "create": { - "description": "Creates new autoscaling policy.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies", + "description": "Create a session template synchronously.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates", "httpMethod": "POST", - "id": "dataproc.projects.regions.autoscalingPolicies.create", + "id": "dataproc.projects.locations.sessionTemplates.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "description": "Required. The parent resource where this session template will be created.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/autoscalingPolicies", + "path": "v1/{+parent}/sessionTemplates", "request": { - "$ref": "AutoscalingPolicy" + "$ref": "SessionTemplate" }, "response": { - "$ref": "AutoscalingPolicy" + "$ref": "SessionTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "delete": { - "description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", + "description": "Deletes a session template.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", "httpMethod": "DELETE", - "id": "dataproc.projects.regions.autoscalingPolicies.delete", + "id": "dataproc.projects.locations.sessionTemplates.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", + "description": "Required. The name of the session template resource to delete.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", "required": true, "type": "string" } @@ -1327,173 +1681,94 @@ ] }, "get": { - "description": "Retrieves autoscaling policy.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", + "description": "Gets the resource representation for a session template.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", "httpMethod": "GET", - "id": "dataproc.projects.regions.autoscalingPolicies.get", + "id": "dataproc.projects.locations.sessionTemplates.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", + "description": "Required. The name of the session template to retrieve.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "AutoscalingPolicy" - }, - "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}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.autoscalingPolicies.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/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" + "$ref": "SessionTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists autoscaling policies in the project.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies", + "description": "Lists session templates.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates", "httpMethod": "GET", - "id": "dataproc.projects.regions.autoscalingPolicies.list", + "id": "dataproc.projects.locations.sessionTemplates.list", "parameterOrder": [ "parent" ], "parameters": { + "filter": { + "description": "Optional. A filter for the session templates to return in the response. Filters are case sensitive and have the following syntax:field = value AND field = value ...", + "location": "query", + "type": "string" + }, "pageSize": { - "description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.", + "description": "Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "description": "Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", - "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/autoscalingPolicies", - "response": { - "$ref": "ListAutoscalingPoliciesResponse" - }, - "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}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.autoscalingPolicies.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/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataproc.projects.regions.autoscalingPolicies.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.", + "description": "Required. The parent that owns this collection of session templates.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, + "path": "v1/{+parent}/sessionTemplates", "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "ListSessionTemplatesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "update": { - "description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", - "httpMethod": "PUT", - "id": "dataproc.projects.regions.autoscalingPolicies.update", + "patch": { + "description": "Updates the session template synchronously.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessionTemplates/{sessionTemplatesId}", + "httpMethod": "PATCH", + "id": "dataproc.projects.locations.sessionTemplates.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", + "description": "Required. The resource name of the session template.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessionTemplates/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "request": { - "$ref": "AutoscalingPolicy" + "$ref": "SessionTemplate" }, "response": { - "$ref": "AutoscalingPolicy" + "$ref": "SessionTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1501,54 +1776,38 @@ } } }, - "clusters": { + "sessions": { "methods": { "create": { - "description": "Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", + "description": "Create an interactive session asynchronously.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions", "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.create", + "id": "dataproc.projects.locations.sessions.create", "parameterOrder": [ - "projectId", - "region" + "parent" ], "parameters": { - "actionOnFailedPrimaryWorkers": { - "description": "Optional. Failure action when primary worker creation fails.", - "enum": [ - "FAILURE_ACTION_UNSPECIFIED", - "NO_ACTION", - "DELETE" - ], - "enumDescriptions": [ - "When FailureAction is unspecified, failure action defaults to NO_ACTION.", - "Take no action on failure to create a cluster resource. NO_ACTION is the default.", - "Delete the failed cluster resource." - ], - "location": "query", - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "parent": { + "description": "Required. The parent resource where this session will be created.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", "type": "string" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two CreateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "sessionId": { + "description": "Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/.", "location": "query", "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/clusters", + "path": "v1/{+parent}/sessions", "request": { - "$ref": "Cluster" + "$ref": "Session" }, "response": { "$ref": "Operation" @@ -1558,93 +1817,28 @@ ] }, "delete": { - "description": "Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "description": "Deletes the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}", "httpMethod": "DELETE", - "id": "dataproc.projects.regions.clusters.delete", + "id": "dataproc.projects.locations.sessions.delete", "parameterOrder": [ - "projectId", - "region", - "clusterName" + "name" ], "parameters": { - "clusterName": { - "description": "Required. The cluster name.", + "name": { + "description": "Required. The name of the session resource to delete.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", "required": true, "type": "string" }, - "clusterUuid": { - "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.", + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "location": "query", "type": "string" - }, - "gracefulTerminationTimeout": { - "description": "Optional. The graceful termination timeout for the deletion of the cluster. Indicate the time the request will wait to complete the running jobs on the cluster before its forceful deletion. Default value is 0 indicating that the user has not enabled the graceful termination. Value can be between 60 second and 6 Hours, in case the graceful termination is enabled. (There is no separate flag to check the enabling or disabling of graceful termination, it can be checked by the values in the field).", - "format": "google-duration", - "location": "query", - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two DeleteClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "diagnose": { - "description": "Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.diagnose", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "request": { - "$ref": "DiagnoseClusterRequest" - }, + "path": "v1/{+name}", "response": { "$ref": "Operation" }, @@ -1653,212 +1847,91 @@ ] }, "get": { - "description": "Gets the resource representation for a cluster in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "description": "Gets the resource representation for an interactive session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}", "httpMethod": "GET", - "id": "dataproc.projects.regions.clusters.get", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "response": { - "$ref": "Cluster" - }, - "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}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.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/[^/]+/regions/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "injectCredentials": { - "description": "Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:injectCredentials", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.injectCredentials", + "id": "dataproc.projects.locations.sessions.get", "parameterOrder": [ - "project", - "region", - "cluster" + "name" ], "parameters": { - "cluster": { - "description": "Required. The cluster, in the form clusters/.", - "location": "path", - "pattern": "^clusters/[^/]+$", - "required": true, - "type": "string" - }, - "project": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The region containing the cluster, of the form regions/.", + "name": { + "description": "Required. The name of the session to retrieve.", "location": "path", - "pattern": "^regions/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+project}/{+region}/{+cluster}:injectCredentials", - "request": { - "$ref": "InjectCredentialsRequest" - }, + "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "Session" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists all regions/{region}/clusters in a project alphabetically.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", + "description": "Lists interactive sessions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions", "httpMethod": "GET", - "id": "dataproc.projects.regions.clusters.list", + "id": "dataproc.projects.locations.sessions.list", "parameterOrder": [ - "projectId", - "region" + "parent" ], "parameters": { "filter": { - "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", + "description": "Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < \"2023-01-01T00:00:00Z\" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. The standard List page size.", + "description": "Optional. The maximum number of sessions to return in each response. The service may return fewer than this value.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The standard List page token.", + "description": "Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page.", "location": "query", "type": "string" }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "parent": { + "description": "Required. The parent, which owns this collection of sessions.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/clusters", + "path": "v1/{+parent}/sessions", "response": { - "$ref": "ListClustersResponse" + "$ref": "ListSessionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "httpMethod": "PATCH", - "id": "dataproc.projects.regions.clusters.patch", + "terminate": { + "description": "Terminates the interactive session.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}:terminate", + "httpMethod": "POST", + "id": "dataproc.projects.locations.sessions.terminate", "parameterOrder": [ - "projectId", - "region", - "clusterName" + "name" ], "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "gracefulDecommissionTimeout": { - "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.", - "format": "google-duration", - "location": "query", - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "name": { + "description": "Required. The name of the session resource to terminate.", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", "required": true, "type": "string" - }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", - "type": "string" - }, - "updateMask": { - "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { \"config\":{ \"secondaryWorkerConfig\":{ \"numInstances\":\"5\" } } } *Note:* Currently, only the following fields can be updated: *Mask* *Purpose* *labels* Update labels *config.worker_config.num_instances* Resize primary worker group *config.secondary_worker_config.num_instances* Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies ", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "path": "v1/{+name}:terminate", "request": { - "$ref": "Cluster" + "$ref": "TerminateSessionRequest" }, "response": { "$ref": "Operation" @@ -1866,599 +1939,1044 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "repair": { - "description": "Repairs a cluster.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.repair", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair", - "request": { - "$ref": "RepairClusterRequest" - }, - "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}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.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/[^/]+/regions/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "start": { - "description": "Starts a cluster in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.start", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start", - "request": { - "$ref": "StartClusterRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "stop": { - "description": "Stops a cluster in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.stop", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "parameters": { - "clusterName": { - "description": "Required. The cluster name.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop", - "request": { - "$ref": "StopClusterRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.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/[^/]+/regions/[^/]+/clusters/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } }, "resources": { - "nodeGroups": { + "sparkApplications": { "methods": { - "create": { - "description": "Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.nodeGroups.create", + "access": { + "description": "Obtain high level information corresponding to a single Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:access", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.access", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "nodeGroupId": { - "description": "Optional. An optional node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}", + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", "required": true, "type": "string" }, - "parentOperationId": { - "description": "Optional. operation id of the parent operation sending the create request", - "location": "query", - "type": "string" - }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequest) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "parent": { + "description": "Required. Parent (Session) resource reference.", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/nodeGroups", - "request": { - "$ref": "NodeGroup" - }, + "path": "v1/{+name}:access", "response": { - "$ref": "Operation" + "$ref": "AccessSessionSparkApplicationResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Gets the resource representation for a node group in a cluster.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}", + "accessEnvironmentInfo": { + "description": "Obtain environment details for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessEnvironmentInfo", "httpMethod": "GET", - "id": "dataproc.projects.regions.clusters.nodeGroups.get", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessEnvironmentInfo", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the node group to retrieve. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", "required": true, "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+name}:accessEnvironmentInfo", "response": { - "$ref": "NodeGroup" + "$ref": "AccessSessionSparkApplicationEnvironmentInfoResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "repair": { - "description": "Repair nodes in a node group.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:repair", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.nodeGroups.repair", + "accessJob": { + "description": "Obtain data corresponding to a spark job for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessJob", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessJob", "parameterOrder": [ "name" ], "parameters": { + "jobId": { + "description": "Required. Job ID to fetch data for.", + "format": "int64", + "location": "query", + "type": "string" + }, "name": { - "description": "Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", "required": true, "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:repair", - "request": { - "$ref": "RepairNodeGroupRequest" - }, + "path": "v1/{+name}:accessJob", "response": { - "$ref": "Operation" + "$ref": "AccessSessionSparkApplicationJobResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "resize": { - "description": "Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:resize", - "httpMethod": "POST", - "id": "dataproc.projects.regions.clusters.nodeGroups.resize", + "accessSqlPlan": { + "description": "Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlPlan", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessSqlPlan", "parameterOrder": [ "name" ], "parameters": { + "executionId": { + "description": "Required. Execution ID", + "format": "int64", + "location": "query", + "type": "string" + }, "name": { - "description": "Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", "required": true, "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:resize", - "request": { - "$ref": "ResizeNodeGroupRequest" - }, + "path": "v1/{+name}:accessSqlPlan", "response": { - "$ref": "Operation" + "$ref": "AccessSessionSparkApplicationSqlSparkPlanGraphResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - } - } - }, - "jobs": { - "methods": { - "cancel": { - "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", - "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.cancel", - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "parameters": { - "jobId": { - "description": "Required. The job ID.", - "location": "path", - "required": true, - "type": "string" }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" + "accessSqlQuery": { + "description": "Obtain data corresponding to a particular SQL Query for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessSqlQuery", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessSqlQuery", + "parameterOrder": [ + "name" + ], + "parameters": { + "details": { + "description": "Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.", + "location": "query", + "type": "boolean" + }, + "executionId": { + "description": "Required. Execution ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "planDescription": { + "description": "Optional. Enables/ disables physical plan description on demand", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:accessSqlQuery", + "response": { + "$ref": "AccessSessionSparkApplicationSqlQueryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", - "request": { - "$ref": "CancelJobRequest" - }, - "response": { - "$ref": "Job" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "httpMethod": "DELETE", - "id": "dataproc.projects.regions.jobs.delete", - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "parameters": { - "jobId": { - "description": "Required. The job ID.", - "location": "path", - "required": true, - "type": "string" + "accessStageAttempt": { + "description": "Obtain data corresponding to a spark stage attempt for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageAttempt", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessStageAttempt", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessStageAttempt", + "response": { + "$ref": "AccessSessionSparkApplicationStageAttemptResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" + "accessStageRddGraph": { + "description": "Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:accessStageRddGraph", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.accessStageRddGraph", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:accessStageRddGraph", + "response": { + "$ref": "AccessSessionSparkApplicationStageRddOperationGraphResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets the resource representation for a job in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "httpMethod": "GET", - "id": "dataproc.projects.regions.jobs.get", - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "parameters": { - "jobId": { - "description": "Required. The job ID.", - "location": "path", - "required": true, - "type": "string" + "search": { + "description": "Obtain high level information and list of Spark Applications corresponding to a batch", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications:search", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.search", + "parameterOrder": [ + "parent" + ], + "parameters": { + "applicationStatus": { + "description": "Optional. Search only applications in the chosen state.", + "enum": [ + "APPLICATION_STATUS_UNSPECIFIED", + "APPLICATION_STATUS_RUNNING", + "APPLICATION_STATUS_COMPLETED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "maxEndTime": { + "description": "Optional. Latest end timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "maxTime": { + "description": "Optional. Latest start timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "minEndTime": { + "description": "Optional. Earliest end timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "minTime": { + "description": "Optional. Earliest start timestamp to list.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplications call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sparkApplications:search", + "response": { + "$ref": "SearchSessionSparkApplicationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" + "searchExecutorStageSummary": { + "description": "Obtain executor summary with respect to a spark stage attempt.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutorStageSummary", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchExecutorStageSummary", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationExecutorStageSummary call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchExecutorStageSummary", + "response": { + "$ref": "SearchSessionSparkApplicationExecutorStageSummaryResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", - "location": "path", - "required": true, - "type": "string" - } - }, - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "response": { - "$ref": "Job" - }, - "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}/regions/{regionsId}/jobs/{jobsId}:getIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.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/[^/]+/regions/[^/]+/jobs/[^/]+$", - "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 regions/{region}/jobs in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs", - "httpMethod": "GET", - "id": "dataproc.projects.regions.jobs.list", - "parameterOrder": [ - "projectId", - "region" - ], - "parameters": { - "clusterName": { - "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", - "location": "query", - "type": "string" + "searchExecutors": { + "description": "Obtain data corresponding to executors for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchExecutors", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchExecutors", + "parameterOrder": [ + "name" + ], + "parameters": { + "executorStatus": { + "description": "Optional. Filter to select whether active/ dead or all executors should be selected.", + "enum": [ + "EXECUTOR_STATUS_UNSPECIFIED", + "EXECUTOR_STATUS_ACTIVE", + "EXECUTOR_STATUS_DEAD" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationExecutors call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchExecutors", + "response": { + "$ref": "SearchSessionSparkApplicationExecutorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "filter": { - "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", - "location": "query", - "type": "string" + "searchJobs": { + "description": "Obtain list of spark jobs corresponding to a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchJobs", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchJobs", + "parameterOrder": [ + "name" + ], + "parameters": { + "jobStatus": { + "description": "Optional. List only jobs in the specific state.", + "enum": [ + "JOB_EXECUTION_STATUS_UNSPECIFIED", + "JOB_EXECUTION_STATUS_RUNNING", + "JOB_EXECUTION_STATUS_SUCCEEDED", + "JOB_EXECUTION_STATUS_FAILED", + "JOB_EXECUTION_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationJobs call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchJobs", + "response": { + "$ref": "SearchSessionSparkApplicationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "jobStateMatcher": { - "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", - "enum": [ - "ALL", - "ACTIVE", - "NON_ACTIVE" + "searchSqlQueries": { + "description": "Obtain data corresponding to SQL Queries for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchSqlQueries", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchSqlQueries", + "parameterOrder": [ + "name" ], - "enumDescriptions": [ - "Match all jobs, regardless of state.", - "Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.", - "Only match jobs in terminal states: CANCELLED, DONE, or ERROR." + "parameters": { + "details": { + "description": "Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "planDescription": { + "description": "Optional. Enables/ disables physical plan description on demand", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}:searchSqlQueries", + "response": { + "$ref": "SearchSessionSparkApplicationSqlQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "searchStageAttemptTasks": { + "description": "Obtain data corresponding to tasks for a spark stage attempt for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttemptTasks", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchStageAttemptTasks", + "parameterOrder": [ + "name" ], - "location": "query", - "type": "string" + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "sortRuntime": { + "description": "Optional. Sort the tasks by runtime.", + "location": "query", + "type": "boolean" + }, + "stageAttemptId": { + "description": "Optional. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Optional. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + }, + "taskStatus": { + "description": "Optional. List only tasks in the state.", + "enum": [ + "TASK_STATUS_UNSPECIFIED", + "TASK_STATUS_RUNNING", + "TASK_STATUS_SUCCESS", + "TASK_STATUS_FAILED", + "TASK_STATUS_KILLED", + "TASK_STATUS_PENDING" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStageAttemptTasks", + "response": { + "$ref": "SearchSessionSparkApplicationStageAttemptTasksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageSize": { - "description": "Optional. The number of results to return in each response.", - "format": "int32", - "location": "query", - "type": "integer" + "searchStageAttempts": { + "description": "Obtain data corresponding to a spark stage attempts for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStageAttempts", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchStageAttempts", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageId": { + "description": "Required. Stage ID for which attempts are to be fetched", + "format": "int64", + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStageAttempts", + "response": { + "$ref": "SearchSessionSparkApplicationStageAttemptsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "pageToken": { - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "location": "query", - "type": "string" + "searchStages": { + "description": "Obtain data corresponding to stages for a Spark Application.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:searchStages", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.searchStages", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token received from a previous SearchSessionSparkApplicationStages call. Provide this token to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageStatus": { + "description": "Optional. List only stages in the given state.", + "enum": [ + "STAGE_STATUS_UNSPECIFIED", + "STAGE_STATUS_ACTIVE", + "STAGE_STATUS_COMPLETE", + "STAGE_STATUS_FAILED", + "STAGE_STATUS_PENDING", + "STAGE_STATUS_SKIPPED" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "location": "query", + "type": "string" + }, + "summaryMetricsMask": { + "description": "Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:searchStages", + "response": { + "$ref": "SearchSessionSparkApplicationStagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" + "summarizeExecutors": { + "description": "Obtain summary of Executor Summary for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeExecutors", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.summarizeExecutors", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeExecutors", + "response": { + "$ref": "SummarizeSessionSparkApplicationExecutorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "summarizeJobs": { + "description": "Obtain summary of Jobs for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeJobs", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.summarizeJobs", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeJobs", + "response": { + "$ref": "SummarizeSessionSparkApplicationJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeStageAttemptTasks": { + "description": "Obtain summary of Tasks for a Spark Application Stage Attempt", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStageAttemptTasks", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.summarizeStageAttemptTasks", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + }, + "stageAttemptId": { + "description": "Required. Stage Attempt ID", + "format": "int32", + "location": "query", + "type": "integer" + }, + "stageId": { + "description": "Required. Stage ID", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeStageAttemptTasks", + "response": { + "$ref": "SummarizeSessionSparkApplicationStageAttemptTasksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "summarizeStages": { + "description": "Obtain summary of Stages for a Spark Application", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:summarizeStages", + "httpMethod": "GET", + "id": "dataproc.projects.locations.sessions.sparkApplications.summarizeStages", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the session to retrieve in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Required. Parent (Session) resource reference.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:summarizeStages", + "response": { + "$ref": "SummarizeSessionSparkApplicationStagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Write wrapper objects from dataplane to spanner", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sessions/{sessionsId}/sparkApplications/{sparkApplicationsId}:write", + "httpMethod": "POST", + "id": "dataproc.projects.locations.sessions.sparkApplications.write", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the spark application to write data about in the format \"projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sessions/[^/]+/sparkApplications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:write", + "request": { + "$ref": "WriteSessionSparkApplicationContextRequest" + }, + "response": { + "$ref": "WriteSessionSparkApplicationContextResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "workflowTemplates": { + "methods": { + "create": { + "description": "Creates new workflow template.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates", + "httpMethod": "POST", + "id": "dataproc.projects.locations.workflowTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/jobs", + "path": "v1/{+parent}/workflowTemplates", + "request": { + "$ref": "WorkflowTemplate" + }, "response": { - "$ref": "ListJobsResponse" + "$ref": "WorkflowTemplate" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates a job in a project.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "httpMethod": "PATCH", - "id": "dataproc.projects.regions.jobs.patch", + "delete": { + "description": "Deletes a workflow template. It does not cancel in-progress workflows.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "DELETE", + "id": "dataproc.projects.locations.workflowTemplates.delete", "parameterOrder": [ - "projectId", - "region", - "jobId" + "name" ], "parameters": { - "jobId": { - "description": "Required. The job ID.", - "location": "path", - "required": true, - "type": "string" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "version": { + "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "GET", + "id": "dataproc.projects.locations.workflowTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" }, - "updateMask": { - "description": "Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. *Note:* Currently, labels is the only field that can be updated.", - "format": "google-fieldmask", + "version": { + "description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.", + "format": "int32", "location": "query", - "type": "string" + "type": "integer" } }, - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "request": { - "$ref": "Job" - }, + "path": "v1/{+name}", "response": { - "$ref": "Job" + "$ref": "WorkflowTemplate" }, "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}/regions/{regionsId}/jobs/{jobsId}:setIamPolicy", + "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}/workflowTemplates/{workflowTemplatesId}:getIamPolicy", "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.setIamPolicy", + "id": "dataproc.projects.locations.workflowTemplates.getIamPolicy", "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.", + "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/[^/]+/regions/[^/]+/jobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:setIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "request": { - "$ref": "SetIamPolicyRequest" + "$ref": "GetIamPolicyRequest" }, "response": { "$ref": "Policy" @@ -2467,69 +2985,126 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "submit": { - "description": "Submits a job to a cluster.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "instantiate": { + "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate", "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.submit", + "id": "dataproc.projects.locations.workflowTemplates.instantiate", "parameterOrder": [ - "projectId", - "region" + "name" ], "parameters": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "location": "path", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "path": "v1/{+name}:instantiate", "request": { - "$ref": "SubmitJobRequest" + "$ref": "InstantiateWorkflowTemplateRequest" }, "response": { - "$ref": "Job" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "submitAsOperation": { - "description": "Submits job to a cluster.", - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation", + "instantiateInline": { + "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline", "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.submitAsOperation", + "id": "dataproc.projects.locations.workflowTemplates.instantiateInline", "parameterOrder": [ - "projectId", - "region" + "parent" ], "parameters": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, - "region": { - "description": "Required. The Dataproc region in which to handle the request.", + "requestId": { + "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/workflowTemplates:instantiateInline", + "request": { + "$ref": "WorkflowTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists workflows that match the specified filter in the request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates", + "httpMethod": "GET", + "id": "dataproc.projects.locations.workflowTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return in each response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation", + "path": "v1/{+parent}/workflowTemplates", + "response": { + "$ref": "ListWorkflowTemplatesResponse" + }, + "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}/workflowTemplates/{workflowTemplatesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.locations.workflowTemplates.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/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", "request": { - "$ref": "SubmitJobRequest" + "$ref": "SetIamPolicyRequest" }, "response": { - "$ref": "Operation" + "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2537,9 +3112,9 @@ }, "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}/regions/{regionsId}/jobs/{jobsId}:testIamPermissions", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions", "httpMethod": "POST", - "id": "dataproc.projects.regions.jobs.testIamPermissions", + "id": "dataproc.projects.locations.workflowTemplates.testIamPermissions", "parameterOrder": [ "resource" ], @@ -2547,7 +3122,7 @@ "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/[^/]+/regions/[^/]+/jobs/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" } @@ -2562,49 +3137,84 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "update": { + "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "PUT", + "id": "dataproc.projects.locations.workflowTemplates.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "WorkflowTemplate" + }, + "response": { + "$ref": "WorkflowTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } - }, - "operations": { + } + } + }, + "regions": { + "resources": { + "autoscalingPolicies": { "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}/regions/{regionsId}/operations/{operationsId}:cancel", + "create": { + "description": "Creates new autoscaling policy.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies", "httpMethod": "POST", - "id": "dataproc.projects.regions.operations.cancel", + "id": "dataproc.projects.regions.autoscalingPolicies.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "parent": { + "description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}:cancel", + "path": "v1/{+parent}/autoscalingPolicies", + "request": { + "$ref": "AutoscalingPolicy" + }, "response": { - "$ref": "Empty" + "$ref": "AutoscalingPolicy" }, "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}/regions/{regionsId}/operations/{operationsId}", + "description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", "httpMethod": "DELETE", - "id": "dataproc.projects.regions.operations.delete", + "id": "dataproc.projects.regions.autoscalingPolicies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } @@ -2618,25 +3228,25 @@ ] }, "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}/regions/{regionsId}/operations/{operationsId}", + "description": "Retrieves autoscaling policy.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", "httpMethod": "GET", - "id": "dataproc.projects.regions.operations.get", + "id": "dataproc.projects.regions.autoscalingPolicies.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "AutoscalingPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2644,9 +3254,9 @@ }, "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}/regions/{regionsId}/operations/{operationsId}:getIamPolicy", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy", "httpMethod": "POST", - "id": "dataproc.projects.regions.operations.getIamPolicy", + "id": "dataproc.projects.regions.autoscalingPolicies.getIamPolicy", "parameterOrder": [ "resource" ], @@ -2654,7 +3264,7 @@ "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/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } @@ -2671,41 +3281,36 @@ ] }, "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}/regions/{regionsId}/operations", + "description": "Lists autoscaling policies in the project.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies", "httpMethod": "GET", - "id": "dataproc.projects.regions.operations.list", + "id": "dataproc.projects.regions.autoscalingPolicies.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/operations$", - "required": true, - "type": "string" - }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", "location": "query", "type": "string" + }, + "parent": { + "description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+$", + "required": true, + "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/{+parent}/autoscalingPolicies", "response": { - "$ref": "ListOperationsResponse" + "$ref": "ListAutoscalingPoliciesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -2713,9 +3318,9 @@ }, "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}/regions/{regionsId}/operations/{operationsId}:setIamPolicy", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy", "httpMethod": "POST", - "id": "dataproc.projects.regions.operations.setIamPolicy", + "id": "dataproc.projects.regions.autoscalingPolicies.setIamPolicy", "parameterOrder": [ "resource" ], @@ -2723,7 +3328,7 @@ "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/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } @@ -2741,9 +3346,9 @@ }, "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}/regions/{regionsId}/operations/{operationsId}:testIamPermissions", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions", "httpMethod": "POST", - "id": "dataproc.projects.regions.operations.testIamPermissions", + "id": "dataproc.projects.regions.autoscalingPolicies.testIamPermissions", "parameterOrder": [ "resource" ], @@ -2751,7 +3356,7 @@ "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/[^/]+/regions/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } @@ -2766,150 +3371,140 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - }, - "workflowTemplates": { - "methods": { - "create": { - "description": "Creates new workflow template.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates", - "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.create", + }, + "update": { + "description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}", + "httpMethod": "PUT", + "id": "dataproc.projects.regions.autoscalingPolicies.update", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "name": { + "description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/workflowTemplates", + "path": "v1/{+name}", "request": { - "$ref": "WorkflowTemplate" + "$ref": "AutoscalingPolicy" }, "response": { - "$ref": "WorkflowTemplate" + "$ref": "AutoscalingPolicy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "delete": { - "description": "Deletes a workflow template. It does not cancel in-progress workflows.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "DELETE", - "id": "dataproc.projects.regions.workflowTemplates.delete", + } + } + }, + "clusters": { + "methods": { + "create": { + "description": "Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.create", "parameterOrder": [ - "name" + "projectId", + "region" ], "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "actionOnFailedPrimaryWorkers": { + "description": "Optional. Failure action when primary worker creation fails.", + "enum": [ + "FAILURE_ACTION_UNSPECIFIED", + "NO_ACTION", + "DELETE" + ], + "enumDescriptions": [ + "When FailureAction is unspecified, failure action defaults to NO_ACTION.", + "Take no action on failure to create a cluster resource. NO_ACTION is the default.", + "Delete the failed cluster resource." + ], + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" }, - "version": { - "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", - "format": "int32", + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two CreateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "location": "query", - "type": "integer" + "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/projects/{projectId}/regions/{region}/clusters", + "request": { + "$ref": "Cluster" + }, "response": { - "$ref": "Empty" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "get": { - "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "GET", - "id": "dataproc.projects.regions.workflowTemplates.get", + "delete": { + "description": "Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "DELETE", + "id": "dataproc.projects.regions.clusters.delete", "parameterOrder": [ - "name" + "projectId", + "region", + "clusterName" ], "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "clusterName": { + "description": "Required. The cluster name.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" }, - "version": { - "description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.", - "format": "int32", + "clusterUuid": { + "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.", "location": "query", - "type": "integer" - } - }, - "path": "v1/{+name}", - "response": { - "$ref": "WorkflowTemplate" - }, - "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy", - "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.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.", + "type": "string" + }, + "gracefulTerminationTimeout": { + "description": "Optional. The graceful termination timeout for the deletion of the cluster. Indicate the time the request will wait to complete the running jobs on the cluster before its forceful deletion. Default value is 0 indicating that the user has not enabled the graceful termination. Value can be between 60 second and 6 Hours, in case the graceful termination is enabled. (There is no separate flag to check the enabling or disabling of graceful termination, it can be checked by the values in the field).", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "instantiate": { - "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate", - "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.instantiate", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two DeleteClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:instantiate", - "request": { - "$ref": "InstantiateWorkflowTemplateRequest" - }, + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", "response": { "$ref": "Operation" }, @@ -2917,31 +3512,39 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "instantiateInline": { - "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline", + "diagnose": { + "description": "Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.instantiateInline", + "id": "dataproc.projects.regions.clusters.diagnose", "parameterOrder": [ - "parent" + "projectId", + "region", + "clusterName" ], "parameters": { - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "clusterName": { + "description": "Required. The cluster name.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+$", "required": true, "type": "string" }, - "requestId": { - "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "location": "query", + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, "type": "string" } }, - "path": "v1/{+parent}/workflowTemplates:instantiateInline", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", "request": { - "$ref": "WorkflowTemplate" + "$ref": "DiagnoseClusterRequest" }, "response": { "$ref": "Operation" @@ -2950,62 +3553,64 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists workflows that match the specified filter in the request.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates", + "get": { + "description": "Gets the resource representation for a cluster in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", "httpMethod": "GET", - "id": "dataproc.projects.regions.workflowTemplates.list", + "id": "dataproc.projects.regions.clusters.get", "parameterOrder": [ - "parent" + "projectId", + "region", + "clusterName" ], "parameters": { - "pageSize": { - "description": "Optional. The maximum number of results to return in each response.", - "format": "int32", - "location": "query", - "type": "integer" + "clusterName": { + "description": "Required. The cluster name.", + "location": "path", + "required": true, + "type": "string" }, - "pageToken": { - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "location": "query", + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "location": "path", + "required": true, "type": "string" }, - "parent": { - "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "region": { + "description": "Required. The Dataproc region in which to handle the request.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/workflowTemplates", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", "response": { - "$ref": "ListWorkflowTemplatesResponse" + "$ref": "Cluster" }, "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy", + "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}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy", "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.setIamPolicy", + "id": "dataproc.projects.regions.clusters.getIamPolicy", "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.", + "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/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:setIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "request": { - "$ref": "SetIamPolicyRequest" + "$ref": "GetIamPolicyRequest" }, "response": { "$ref": "Policy" @@ -3014,708 +3619,4906 @@ "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions", + "injectCredentials": { + "description": "Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:injectCredentials", "httpMethod": "POST", - "id": "dataproc.projects.regions.workflowTemplates.testIamPermissions", + "id": "dataproc.projects.regions.clusters.injectCredentials", "parameterOrder": [ - "resource" + "project", + "region", + "cluster" ], "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.", + "cluster": { + "description": "Required. The cluster, in the form clusters/.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "pattern": "^clusters/[^/]+$", "required": true, "type": "string" - } + }, + "project": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to, of the form projects/.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The region containing the cluster, of the form regions/.", + "location": "path", + "pattern": "^regions/[^/]+$", + "required": true, + "type": "string" + } }, - "path": "v1/{+resource}:testIamPermissions", + "path": "v1/{+project}/{+region}/{+cluster}:injectCredentials", "request": { - "$ref": "TestIamPermissionsRequest" + "$ref": "InjectCredentialsRequest" }, "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "update": { - "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "httpMethod": "PUT", - "id": "dataproc.projects.regions.workflowTemplates.update", + "list": { + "description": "Lists all regions/{region}/clusters in a project alphabetically.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", + "httpMethod": "GET", + "id": "dataproc.projects.regions.clusters.list", "parameterOrder": [ - "name" + "projectId", + "region" ], "parameters": { - "name": { - "description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "filter": { + "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, UPDATING, STOPPING, or STOPPED. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING, ERROR, STOPPING, and STOPPED states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", + "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" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", "location": "path", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+name}", + "path": "v1/projects/{projectId}/regions/{region}/clusters", + "response": { + "$ref": "ListClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "httpMethod": "PATCH", + "id": "dataproc.projects.regions.clusters.patch", + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "clusterName": { + "description": "Required. The cluster name.", + "location": "path", + "required": true, + "type": "string" + }, + "gracefulDecommissionTimeout": { + "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.", + "format": "google-duration", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two UpdateClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.UpdateClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { \"config\":{ \"secondaryWorkerConfig\":{ \"numInstances\":\"5\" } } } *Note:* Currently, only the following fields can be updated: *Mask* *Purpose* *labels* Update labels *config.worker_config.num_instances* Resize primary worker group *config.secondary_worker_config.num_instances* Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies ", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", "request": { - "$ref": "WorkflowTemplate" + "$ref": "Cluster" }, "response": { - "$ref": "WorkflowTemplate" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - } - } - } - } + }, + "repair": { + "description": "Repairs a cluster.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.repair", + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "clusterName": { + "description": "Required. The cluster name.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:repair", + "request": { + "$ref": "RepairClusterRequest" + }, + "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}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.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/[^/]+/regions/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "start": { + "description": "Starts a cluster in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.start", + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "clusterName": { + "description": "Required. The cluster name.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start", + "request": { + "$ref": "StartClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "stop": { + "description": "Stops a cluster in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.stop", + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "clusterName": { + "description": "Required. The cluster name.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop", + "request": { + "$ref": "StopClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.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/[^/]+/regions/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "nodeGroups": { + "methods": { + "create": { + "description": "Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.nodeGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "nodeGroupId": { + "description": "Optional. An optional node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this node group will be created. Format: projects/{project}/regions/{region}/clusters/{cluster}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "parentOperationId": { + "description": "Optional. operation id of the parent operation sending the create request", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequest) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/nodeGroups", + "request": { + "$ref": "NodeGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the resource representation for a node group in a cluster.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}", + "httpMethod": "GET", + "id": "dataproc.projects.regions.clusters.nodeGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the node group to retrieve. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "NodeGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "repair": { + "description": "Repair nodes in a node group.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:repair", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.nodeGroups.repair", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:repair", + "request": { + "$ref": "RepairNodeGroupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resize": { + "description": "Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata).", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}/nodeGroups/{nodeGroupsId}:resize", + "httpMethod": "POST", + "id": "dataproc.projects.regions.clusters.nodeGroups.resize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the node group to resize. Format: projects/{project}/regions/{region}/clusters/{cluster}/nodeGroups/{nodeGroup}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+/nodeGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:resize", + "request": { + "$ref": "ResizeNodeGroupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "jobs": { + "methods": { + "cancel": { + "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.cancel", + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "parameters": { + "jobId": { + "description": "Required. The job ID.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "request": { + "$ref": "CancelJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "DELETE", + "id": "dataproc.projects.regions.jobs.delete", + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "parameters": { + "jobId": { + "description": "Required. The job ID.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the resource representation for a job in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "GET", + "id": "dataproc.projects.regions.jobs.get", + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "parameters": { + "jobId": { + "description": "Required. The job ID.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "response": { + "$ref": "Job" + }, + "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}/regions/{regionsId}/jobs/{jobsId}:getIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.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/[^/]+/regions/[^/]+/jobs/[^/]+$", + "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 regions/{region}/jobs in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs", + "httpMethod": "GET", + "id": "dataproc.projects.regions.jobs.list", + "parameterOrder": [ + "projectId", + "region" + ], + "parameters": { + "clusterName": { + "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", + "location": "query", + "type": "string" + }, + "jobStateMatcher": { + "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", + "enum": [ + "ALL", + "ACTIVE", + "NON_ACTIVE" + ], + "enumDescriptions": [ + "Match all jobs, regardless of state.", + "Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.", + "Only match jobs in terminal states: CANCELLED, DONE, or ERROR." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The number of results to return in each response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs", + "response": { + "$ref": "ListJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a job in a project.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "httpMethod": "PATCH", + "id": "dataproc.projects.regions.jobs.patch", + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "parameters": { + "jobId": { + "description": "Required. The job ID.", + "location": "path", + "required": true, + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. *Note:* Currently, labels is the only field that can be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "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}/regions/{regionsId}/jobs/{jobsId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.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/[^/]+/regions/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "submit": { + "description": "Submits a job to a cluster.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.submit", + "parameterOrder": [ + "projectId", + "region" + ], + "parameters": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "request": { + "$ref": "SubmitJobRequest" + }, + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "submitAsOperation": { + "description": "Submits job to a cluster.", + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.submitAsOperation", + "parameterOrder": [ + "projectId", + "region" + ], + "parameters": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "location": "path", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Dataproc region in which to handle the request.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation", + "request": { + "$ref": "SubmitJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataproc.projects.regions.jobs.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/[^/]+/regions/[^/]+/jobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "dataproc.projects.regions.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "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}/regions/{regionsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "dataproc.projects.regions.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/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}/regions/{regionsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "dataproc.projects.regions.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$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}/regions/{regionsId}/operations/{operationsId}:getIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.operations.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/[^/]+/regions/[^/]+/operations/[^/]+$", + "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 operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations", + "httpMethod": "GET", + "id": "dataproc.projects.regions.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/[^/]+/regions/[^/]+/operations$", + "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}", + "response": { + "$ref": "ListOperationsResponse" + }, + "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}/regions/{regionsId}/operations/{operationsId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.operations.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/[^/]+/regions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataproc.projects.regions.operations.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/[^/]+/regions/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "workflowTemplates": { + "methods": { + "create": { + "description": "Creates new workflow template.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workflowTemplates", + "request": { + "$ref": "WorkflowTemplate" + }, + "response": { + "$ref": "WorkflowTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a workflow template. It does not cancel in-progress workflows.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "DELETE", + "id": "dataproc.projects.regions.workflowTemplates.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "GET", + "id": "dataproc.projects.regions.workflowTemplates.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + }, + "version": { + "description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "WorkflowTemplate" + }, + "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.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/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "instantiate": { + "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.instantiate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:instantiate", + "request": { + "$ref": "InstantiateWorkflowTemplateRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "instantiateInline": { + "description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.instantiateInline", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/workflowTemplates:instantiateInline", + "request": { + "$ref": "WorkflowTemplate" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists workflows that match the specified filter in the request.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates", + "httpMethod": "GET", + "id": "dataproc.projects.regions.workflowTemplates.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return in each response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/workflowTemplates", + "response": { + "$ref": "ListWorkflowTemplatesResponse" + }, + "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}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.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/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataproc.projects.regions.workflowTemplates.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/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "httpMethod": "PUT", + "id": "dataproc.projects.regions.workflowTemplates.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "WorkflowTemplate" + }, + "response": { + "$ref": "WorkflowTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20240928", + "rootUrl": "https://dataproc.googleapis.com/", + "schemas": { + "AcceleratorConfig": { + "description": "Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).", + "id": "AcceleratorConfig", + "properties": { + "acceleratorCount": { + "description": "The number of the accelerator cards of this type exposed to this instance.", + "format": "int32", + "type": "integer" + }, + "acceleratorTypeUri": { + "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 nvidia-tesla-t4Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-t4.", + "type": "string" + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationEnvironmentInfoResponse": { + "description": "Environment details of a Saprk Application.", + "id": "AccessSessionSparkApplicationEnvironmentInfoResponse", + "properties": { + "applicationEnvironmentInfo": { + "$ref": "ApplicationEnvironmentInfo", + "description": "Details about the Environment that the application is running in." + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationJobResponse": { + "description": "Details of a particular job associated with Spark Application", + "id": "AccessSessionSparkApplicationJobResponse", + "properties": { + "jobData": { + "$ref": "JobData", + "description": "Output only. Data corresponding to a spark job.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationResponse": { + "description": "A summary of Spark Application", + "id": "AccessSessionSparkApplicationResponse", + "properties": { + "application": { + "$ref": "ApplicationInfo", + "description": "Output only. High level information corresponding to an application.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationSqlQueryResponse": { + "description": "Details of a query for a Spark Application", + "id": "AccessSessionSparkApplicationSqlQueryResponse", + "properties": { + "executionData": { + "$ref": "SqlExecutionUiData", + "description": "SQL Execution Data" + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationSqlSparkPlanGraphResponse": { + "description": "SparkPlanGraph for a Spark Application execution limited to maximum 10000 clusters.", + "id": "AccessSessionSparkApplicationSqlSparkPlanGraphResponse", + "properties": { + "sparkPlanGraph": { + "$ref": "SparkPlanGraph", + "description": "SparkPlanGraph for a Spark Application execution." + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationStageAttemptResponse": { + "description": "Stage Attempt for a Stage of a Spark Application", + "id": "AccessSessionSparkApplicationStageAttemptResponse", + "properties": { + "stageData": { + "$ref": "StageData", + "description": "Output only. Data corresponding to a stage.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSessionSparkApplicationStageRddOperationGraphResponse": { + "description": "RDD operation graph for a Spark Application Stage limited to maximum 10000 clusters.", + "id": "AccessSessionSparkApplicationStageRddOperationGraphResponse", + "properties": { + "rddOperationGraph": { + "$ref": "RddOperationGraph", + "description": "RDD operation graph for a Spark Application Stage." + } + }, + "type": "object" + }, + "AccessSparkApplicationEnvironmentInfoResponse": { + "description": "Environment details of a Saprk Application.", + "id": "AccessSparkApplicationEnvironmentInfoResponse", + "properties": { + "applicationEnvironmentInfo": { + "$ref": "ApplicationEnvironmentInfo", + "description": "Details about the Environment that the application is running in." + } + }, + "type": "object" + }, + "AccessSparkApplicationJobResponse": { + "description": "Details of a particular job associated with Spark Application", + "id": "AccessSparkApplicationJobResponse", + "properties": { + "jobData": { + "$ref": "JobData", + "description": "Output only. Data corresponding to a spark job.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSparkApplicationResponse": { + "description": "A summary of Spark Application", + "id": "AccessSparkApplicationResponse", + "properties": { + "application": { + "$ref": "ApplicationInfo", + "description": "Output only. High level information corresponding to an application.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSparkApplicationSqlQueryResponse": { + "description": "Details of a query for a Spark Application", + "id": "AccessSparkApplicationSqlQueryResponse", + "properties": { + "executionData": { + "$ref": "SqlExecutionUiData", + "description": "SQL Execution Data" + } + }, + "type": "object" + }, + "AccessSparkApplicationSqlSparkPlanGraphResponse": { + "description": "SparkPlanGraph for a Spark Application execution limited to maximum 10000 clusters.", + "id": "AccessSparkApplicationSqlSparkPlanGraphResponse", + "properties": { + "sparkPlanGraph": { + "$ref": "SparkPlanGraph", + "description": "SparkPlanGraph for a Spark Application execution." + } + }, + "type": "object" + }, + "AccessSparkApplicationStageAttemptResponse": { + "description": "Stage Attempt for a Stage of a Spark Application", + "id": "AccessSparkApplicationStageAttemptResponse", + "properties": { + "stageData": { + "$ref": "StageData", + "description": "Output only. Data corresponding to a stage.", + "readOnly": true + } + }, + "type": "object" + }, + "AccessSparkApplicationStageRddOperationGraphResponse": { + "description": "RDD operation graph for a Spark Application Stage limited to maximum 10000 clusters.", + "id": "AccessSparkApplicationStageRddOperationGraphResponse", + "properties": { + "rddOperationGraph": { + "$ref": "RddOperationGraph", + "description": "RDD operation graph for a Spark Application Stage." + } + }, + "type": "object" + }, + "AccumulableInfo": { + "id": "AccumulableInfo", + "properties": { + "accumullableInfoId": { + "format": "int64", + "type": "string" + }, + "name": { + "type": "string" + }, + "update": { + "type": "string" + }, + "value": { + "type": "string" + } + }, + "type": "object" + }, + "AnalyzeBatchRequest": { + "description": "A request to analyze a batch workload.", + "id": "AnalyzeBatchRequest", + "properties": { + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + } + }, + "type": "object" + }, + "AnalyzeOperationMetadata": { + "description": "Metadata describing the Analyze operation.", + "id": "AnalyzeOperationMetadata", + "properties": { + "analyzedWorkloadName": { + "description": "Output only. name of the workload being analyzed.", + "readOnly": true, + "type": "string" + }, + "analyzedWorkloadType": { + "description": "Output only. Type of the workload being analyzed.", + "enum": [ + "WORKLOAD_TYPE_UNSPECIFIED", + "BATCH" + ], + "enumDescriptions": [ + "Undefined option", + "Serverless batch job" + ], + "readOnly": true, + "type": "string" + }, + "analyzedWorkloadUuid": { + "description": "Output only. unique identifier of the workload typically generated by control plane. E.g. batch uuid.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the operation was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Short description of the operation.", + "readOnly": true, + "type": "string" + }, + "doneTime": { + "description": "Output only. The time when the operation finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. Labels associated with the operation.", + "readOnly": true, + "type": "object" + }, + "warnings": { + "description": "Output only. Warnings encountered during operation execution.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "AppSummary": { + "id": "AppSummary", + "properties": { + "numCompletedJobs": { + "format": "int32", + "type": "integer" + }, + "numCompletedStages": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ApplicationAttemptInfo": { + "description": "Specific attempt of an application.", + "id": "ApplicationAttemptInfo", + "properties": { + "appSparkVersion": { + "type": "string" + }, + "attemptId": { + "type": "string" + }, + "completed": { + "type": "boolean" + }, + "durationMillis": { + "format": "int64", + "type": "string" + }, + "endTime": { + "format": "google-datetime", + "type": "string" + }, + "lastUpdated": { + "format": "google-datetime", + "type": "string" + }, + "sparkUser": { + "type": "string" + }, + "startTime": { + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ApplicationEnvironmentInfo": { + "description": "Details about the Environment that the application is running in.", + "id": "ApplicationEnvironmentInfo", + "properties": { + "classpathEntries": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "hadoopProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "metricsProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "resourceProfiles": { + "items": { + "$ref": "ResourceProfileInfo" + }, + "type": "array" + }, + "runtime": { + "$ref": "SparkRuntimeInfo" + }, + "sparkProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "systemProperties": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ApplicationInfo": { + "description": "High level information corresponding to an application.", + "id": "ApplicationInfo", + "properties": { + "applicationContextIngestionStatus": { + "enum": [ + "APPLICATION_CONTEXT_INGESTION_STATUS_UNSPECIFIED", + "APPLICATION_CONTEXT_INGESTION_STATUS_COMPLETED" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "applicationId": { + "type": "string" + }, + "attempts": { + "items": { + "$ref": "ApplicationAttemptInfo" + }, + "type": "array" + }, + "coresGranted": { + "format": "int32", + "type": "integer" + }, + "coresPerExecutor": { + "format": "int32", + "type": "integer" + }, + "maxCores": { + "format": "int32", + "type": "integer" + }, + "memoryPerExecutorMb": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "quantileDataStatus": { + "enum": [ + "QUANTILE_DATA_STATUS_UNSPECIFIED", + "QUANTILE_DATA_STATUS_COMPLETED", + "QUANTILE_DATA_STATUS_FAILED" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "AutoscalingConfig": { + "description": "Autoscaling Policy config associated with the cluster.", + "id": "AutoscalingConfig", + "properties": { + "policyUri": { + "description": "Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.", + "type": "string" + } + }, + "type": "object" + }, + "AutoscalingPolicy": { + "description": "Describes an autoscaling policy for Dataproc cluster autoscaler.", + "id": "AutoscalingPolicy", + "properties": { + "basicAlgorithm": { + "$ref": "BasicAutoscalingAlgorithm" + }, + "id": { + "description": "Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with an autoscaling policy.", + "type": "object" + }, + "name": { + "description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", + "readOnly": true, + "type": "string" + }, + "secondaryWorkerConfig": { + "$ref": "InstanceGroupAutoscalingPolicyConfig", + "description": "Optional. Describes how the autoscaler will operate for secondary workers." + }, + "workerConfig": { + "$ref": "InstanceGroupAutoscalingPolicyConfig", + "description": "Required. Describes how the autoscaler will operate for primary workers." + } + }, + "type": "object" + }, + "AutotuningConfig": { + "description": "Autotuning configuration of the workload.", + "id": "AutotuningConfig", + "properties": { + "scenarios": { + "description": "Optional. Scenarios for which tunings are applied.", + "items": { + "enum": [ + "SCENARIO_UNSPECIFIED", + "SCALING", + "BROADCAST_HASH_JOIN", + "MEMORY" + ], + "enumDescriptions": [ + "Default value.", + "Scaling recommendations such as initialExecutors.", + "Adding hints for potential relation broadcasts.", + "Memory management for workloads." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuxiliaryNodeGroup": { + "description": "Node group identification and configuration information.", + "id": "AuxiliaryNodeGroup", + "properties": { + "nodeGroup": { + "$ref": "NodeGroup", + "description": "Required. Node group configuration." + }, + "nodeGroupId": { + "description": "Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.", + "type": "string" + } + }, + "type": "object" + }, + "AuxiliaryServicesConfig": { + "description": "Auxiliary services configuration for a Cluster.", + "id": "AuxiliaryServicesConfig", + "properties": { + "metastoreConfig": { + "$ref": "MetastoreConfig", + "description": "Optional. The Hive Metastore configuration for this workload." + }, + "sparkHistoryServerConfig": { + "$ref": "SparkHistoryServerConfig", + "description": "Optional. The Spark History Server configuration for the workload." + } + }, + "type": "object" + }, + "BasicAutoscalingAlgorithm": { + "description": "Basic algorithm for autoscaling.", + "id": "BasicAutoscalingAlgorithm", + "properties": { + "cooldownPeriod": { + "description": "Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.", + "format": "google-duration", + "type": "string" + }, + "sparkStandaloneConfig": { + "$ref": "SparkStandaloneAutoscalingConfig", + "description": "Optional. Spark Standalone autoscaling configuration" + }, + "yarnConfig": { + "$ref": "BasicYarnAutoscalingConfig", + "description": "Optional. YARN autoscaling configuration." + } + }, + "type": "object" + }, + "BasicYarnAutoscalingConfig": { + "description": "Basic autoscaling configurations for YARN.", + "id": "BasicYarnAutoscalingConfig", + "properties": { + "gracefulDecommissionTimeout": { + "description": "Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.", + "format": "google-duration", + "type": "string" + }, + "scaleDownFactor": { + "description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.", + "format": "double", + "type": "number" + }, + "scaleDownMinWorkerFraction": { + "description": "Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", + "format": "double", + "type": "number" + }, + "scaleUpFactor": { + "description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.", + "format": "double", + "type": "number" + }, + "scaleUpMinWorkerFraction": { + "description": "Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "Batch": { + "description": "A representation of a batch workload in the service.", + "id": "Batch", + "properties": { + "createTime": { + "description": "Output only. The time when the batch was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "description": "Output only. The email address of the user who created the batch.", + "readOnly": true, + "type": "string" + }, + "environmentConfig": { + "$ref": "EnvironmentConfig", + "description": "Optional. Environment configuration for the batch execution." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of the batch.", + "readOnly": true, + "type": "string" + }, + "operation": { + "description": "Output only. The resource name of the operation associated with this batch.", + "readOnly": true, + "type": "string" + }, + "pysparkBatch": { + "$ref": "PySparkBatch", + "description": "Optional. PySpark batch config." + }, + "runtimeConfig": { + "$ref": "RuntimeConfig", + "description": "Optional. Runtime configuration for the batch execution." + }, + "runtimeInfo": { + "$ref": "RuntimeInfo", + "description": "Output only. Runtime information about batch execution.", + "readOnly": true + }, + "sparkBatch": { + "$ref": "SparkBatch", + "description": "Optional. Spark batch config." + }, + "sparkRBatch": { + "$ref": "SparkRBatch", + "description": "Optional. SparkR batch config." + }, + "sparkSqlBatch": { + "$ref": "SparkSqlBatch", + "description": "Optional. SparkSql batch config." + }, + "state": { + "description": "Output only. The state of the batch.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "CANCELLING", + "CANCELLED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The batch state is unknown.", + "The batch is created before running.", + "The batch is running.", + "The batch is cancelling.", + "The batch cancellation was successful.", + "The batch completed successfully.", + "The batch is no longer running due to an error." + ], + "readOnly": true, + "type": "string" + }, + "stateHistory": { + "description": "Output only. Historical state information for the batch.", + "items": { + "$ref": "StateHistory" + }, + "readOnly": true, + "type": "array" + }, + "stateMessage": { + "description": "Output only. Batch state details, such as a failure description if the state is FAILED.", + "readOnly": true, + "type": "string" + }, + "stateTime": { + "description": "Output only. The time when the batch entered a current state.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "uuid": { + "description": "Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BatchOperationMetadata": { + "description": "Metadata describing the Batch operation.", + "id": "BatchOperationMetadata", + "properties": { + "batch": { + "description": "Name of the batch for the operation.", + "type": "string" + }, + "batchUuid": { + "description": "Batch UUID for the operation.", + "type": "string" + }, + "createTime": { + "description": "The time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Short description of the operation.", + "type": "string" + }, + "doneTime": { + "description": "The time when the operation finished.", + "format": "google-datetime", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with the operation.", + "type": "object" + }, + "operationType": { + "description": "The operation type.", + "enum": [ + "BATCH_OPERATION_TYPE_UNSPECIFIED", + "BATCH" + ], + "enumDescriptions": [ + "Batch operation type is unknown.", + "Batch operation type." + ], + "type": "string" + }, + "warnings": { + "description": "Warnings encountered during operation execution.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates members, or principals, with a role.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, + "CancelJobRequest": { + "description": "A request to cancel a job.", + "id": "CancelJobRequest", + "properties": {}, + "type": "object" + }, + "Cluster": { + "description": "Describes the identifying information, config, and status of a Dataproc cluster", + "id": "Cluster", + "properties": { + "clusterName": { + "description": "Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.", + "type": "string" + }, + "clusterUuid": { + "description": "Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.", + "readOnly": true, + "type": "string" + }, + "config": { + "$ref": "ClusterConfig", + "description": "Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.Exactly one of ClusterConfig or VirtualClusterConfig must be specified." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.", + "type": "object" + }, + "metrics": { + "$ref": "ClusterMetrics", + "description": "Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "readOnly": true + }, + "projectId": { + "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", + "type": "string" + }, + "status": { + "$ref": "ClusterStatus", + "description": "Output only. Cluster status.", + "readOnly": true + }, + "statusHistory": { + "description": "Output only. The previous cluster status.", + "items": { + "$ref": "ClusterStatus" + }, + "readOnly": true, + "type": "array" + }, + "virtualClusterConfig": { + "$ref": "VirtualClusterConfig", + "description": "Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified." + } + }, + "type": "object" + }, + "ClusterConfig": { + "description": "The cluster config.", + "id": "ClusterConfig", + "properties": { + "autoscalingConfig": { + "$ref": "AutoscalingConfig", + "description": "Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset." + }, + "auxiliaryNodeGroups": { + "description": "Optional. The node group settings.", + "items": { + "$ref": "AuxiliaryNodeGroup" + }, + "type": "array" + }, + "configBucket": { + "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "type": "string" + }, + "dataprocMetricConfig": { + "$ref": "DataprocMetricConfig", + "description": "Optional. The config for Dataproc metrics." + }, + "encryptionConfig": { + "$ref": "EncryptionConfig", + "description": "Optional. Encryption settings for the cluster." + }, + "endpointConfig": { + "$ref": "EndpointConfig", + "description": "Optional. Port/endpoint configuration for this cluster" + }, + "gceClusterConfig": { + "$ref": "GceClusterConfig", + "description": "Optional. The shared Compute Engine config settings for all instances in a cluster." + }, + "gkeClusterConfig": { + "$ref": "GkeClusterConfig", + "deprecated": true, + "description": "Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. These config settings are mutually exclusive with Compute Engine-based options, such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config." + }, + "initializationActions": { + "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi ", + "items": { + "$ref": "NodeInitializationAction" + }, + "type": "array" + }, + "lifecycleConfig": { + "$ref": "LifecycleConfig", + "description": "Optional. Lifecycle setting for the cluster." + }, + "masterConfig": { + "$ref": "InstanceGroupConfig", + "description": "Optional. The Compute Engine config settings for the cluster's master instance." + }, + "metastoreConfig": { + "$ref": "MetastoreConfig", + "description": "Optional. Metastore configuration." + }, + "secondaryWorkerConfig": { + "$ref": "InstanceGroupConfig", + "description": "Optional. The Compute Engine config settings for a cluster's secondary worker instances" + }, + "securityConfig": { + "$ref": "SecurityConfig", + "description": "Optional. Security settings for the cluster." + }, + "softwareConfig": { + "$ref": "SoftwareConfig", + "description": "Optional. The config settings for cluster software." + }, + "tempBucket": { + "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "type": "string" + }, + "workerConfig": { + "$ref": "InstanceGroupConfig", + "description": "Optional. The Compute Engine config settings for the cluster's worker instances." + } + }, + "type": "object" + }, + "ClusterMetrics": { + "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "id": "ClusterMetrics", + "properties": { + "hdfsMetrics": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "The HDFS metrics.", + "type": "object" + }, + "yarnMetrics": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "YARN metrics.", + "type": "object" + } + }, + "type": "object" + }, + "ClusterOperation": { + "description": "The cluster operation triggered by a workflow.", + "id": "ClusterOperation", + "properties": { + "done": { + "description": "Output only. Indicates the operation is done.", + "readOnly": true, + "type": "boolean" + }, + "error": { + "description": "Output only. Error, if operation failed.", + "readOnly": true, + "type": "string" + }, + "operationId": { + "description": "Output only. The id of the cluster operation.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ClusterOperationMetadata": { + "description": "Metadata describing the operation.", + "id": "ClusterOperationMetadata", + "properties": { + "childOperationIds": { + "description": "Output only. Child operation ids", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "clusterName": { + "description": "Output only. Name of the cluster for the operation.", + "readOnly": true, + "type": "string" + }, + "clusterUuid": { + "description": "Output only. Cluster UUID for the operation.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. Short description of operation.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. Labels associated with the operation", + "readOnly": true, + "type": "object" + }, + "operationType": { + "description": "Output only. The operation type.", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "ClusterOperationStatus", + "description": "Output only. Current operation status.", + "readOnly": true + }, + "statusHistory": { + "description": "Output only. The previous operation status.", + "items": { + "$ref": "ClusterOperationStatus" + }, + "readOnly": true, + "type": "array" + }, + "warnings": { + "description": "Output only. Errors encountered during operation execution.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ClusterOperationStatus": { + "description": "The status of the operation.", + "id": "ClusterOperationStatus", + "properties": { + "details": { + "description": "Output only. A message containing any operation metadata details.", + "readOnly": true, + "type": "string" + }, + "innerState": { + "description": "Output only. A message containing the detailed operation state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. A message containing the operation state.", + "enum": [ + "UNKNOWN", + "PENDING", + "RUNNING", + "DONE" + ], + "enumDescriptions": [ + "Unused.", + "The operation has been created.", + "The operation is running.", + "The operation is done; either cancelled or completed." + ], + "readOnly": true, + "type": "string" + }, + "stateStartTime": { + "description": "Output only. The time this state was entered.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ClusterSelector": { + "description": "A selector that chooses target cluster for jobs based on metadata.", + "id": "ClusterSelector", + "properties": { + "clusterLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. The cluster labels. Cluster must have all labels to match.", + "type": "object" + }, + "zone": { + "description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.", + "type": "string" + } + }, + "type": "object" + }, + "ClusterStatus": { + "description": "The status of a cluster and its instances.", + "id": "ClusterStatus", + "properties": { + "detail": { + "description": "Optional. Output only. Details of cluster's state.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The cluster's state.", + "enum": [ + "UNKNOWN", + "CREATING", + "RUNNING", + "ERROR", + "ERROR_DUE_TO_UPDATE", + "DELETING", + "UPDATING", + "STOPPING", + "STOPPED", + "STARTING", + "REPAIRING" + ], + "enumDescriptions": [ + "The cluster state is unknown.", + "The cluster is being created and set up. It is not ready for use.", + "The cluster is currently running and healthy. It is ready for use.Note: The cluster state changes from \"creating\" to \"running\" status after the master node(s), first two primary worker nodes (and the last primary worker node if primary workers > 2) are running.", + "The cluster encountered an error. It is not ready for use.", + "The cluster has encountered an error while being updated. Jobs can be submitted to the cluster, but the cluster cannot be updated.", + "The cluster is being deleted. It cannot be used.", + "The cluster is being updated. It continues to accept and process jobs.", + "The cluster is being stopped. It cannot be used.", + "The cluster is currently stopped. It is not ready for use.", + "The cluster is being started. It is not ready for use.", + "The cluster is being repaired. It is not ready for use." + ], + "readOnly": true, + "type": "string" + }, + "stateStartTime": { + "description": "Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "substate": { + "description": "Output only. Additional state information that includes status reported by the agent.", + "enum": [ + "UNSPECIFIED", + "UNHEALTHY", + "STALE_STATUS" + ], + "enumDescriptions": [ + "The cluster substate is unknown.", + "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.", + "The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ClusterToRepair": { + "description": "Cluster to be repaired", + "id": "ClusterToRepair", + "properties": { + "clusterRepairAction": { + "description": "Required. Repair action to take on the cluster resource.", + "enum": [ + "CLUSTER_REPAIR_ACTION_UNSPECIFIED", + "REPAIR_ERROR_DUE_TO_UPDATE_CLUSTER" + ], + "enumDescriptions": [ + "No action will be taken by default.", + "Repair cluster in ERROR_DUE_TO_UPDATE states." + ], + "type": "string" + } + }, + "type": "object" + }, + "ConfidentialInstanceConfig": { + "description": "Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs)", + "id": "ConfidentialInstanceConfig", + "properties": { + "enableConfidentialCompute": { + "description": "Optional. Defines whether the instance should have confidential compute enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "ConsolidatedExecutorSummary": { + "description": "Consolidated summary about executors used by the application.", + "id": "ConsolidatedExecutorSummary", + "properties": { + "activeTasks": { + "format": "int32", + "type": "integer" + }, + "completedTasks": { + "format": "int32", + "type": "integer" + }, + "count": { + "format": "int32", + "type": "integer" + }, + "diskUsed": { + "format": "int64", + "type": "string" + }, + "failedTasks": { + "format": "int32", + "type": "integer" + }, + "isExcluded": { + "format": "int32", + "type": "integer" + }, + "maxMemory": { + "format": "int64", + "type": "string" + }, + "memoryMetrics": { + "$ref": "MemoryMetrics" + }, + "memoryUsed": { + "format": "int64", + "type": "string" + }, + "rddBlocks": { + "format": "int32", + "type": "integer" + }, + "totalCores": { + "format": "int32", + "type": "integer" + }, + "totalDurationMillis": { + "format": "int64", + "type": "string" + }, + "totalGcTimeMillis": { + "format": "int64", + "type": "string" + }, + "totalInputBytes": { + "format": "int64", + "type": "string" + }, + "totalShuffleRead": { + "format": "int64", + "type": "string" + }, + "totalShuffleWrite": { + "format": "int64", + "type": "string" + }, + "totalTasks": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DataprocMetricConfig": { + "description": "Dataproc metric config.", + "id": "DataprocMetricConfig", + "properties": { + "metrics": { + "description": "Required. Metrics sources to enable.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, + "DiagnoseClusterRequest": { + "description": "A request to collect cluster diagnostic information.", + "id": "DiagnoseClusterRequest", + "properties": { + "diagnosisInterval": { + "$ref": "Interval", + "description": "Optional. Time interval in which diagnosis should be carried out on the cluster." + }, + "job": { + "deprecated": true, + "description": "Optional. DEPRECATED Specifies the job on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}", + "type": "string" + }, + "jobs": { + "description": "Optional. Specifies a list of jobs on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}", + "items": { + "type": "string" + }, + "type": "array" + }, + "tarballAccess": { + "description": "Optional. (Optional) The access type to the diagnostic tarball. If not specified, falls back to default access of the bucket", + "enum": [ + "TARBALL_ACCESS_UNSPECIFIED", + "GOOGLE_CLOUD_SUPPORT", + "GOOGLE_DATAPROC_DIAGNOSE" + ], + "enumDescriptions": [ + "Tarball Access unspecified. Falls back to default access of the bucket", + "Google Cloud Support group has read access to the diagnostic tarball", + "Google Cloud Dataproc Diagnose service account has read access to the diagnostic tarball" + ], + "type": "string" + }, + "tarballGcsDir": { + "description": "Optional. (Optional) The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.", + "type": "string" + }, + "yarnApplicationId": { + "deprecated": true, + "description": "Optional. DEPRECATED Specifies the yarn application on which diagnosis is to be performed.", + "type": "string" + }, + "yarnApplicationIds": { + "description": "Optional. Specifies a list of yarn applications on which diagnosis is to be performed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DiagnoseClusterResults": { + "description": "The location of diagnostic output.", + "id": "DiagnoseClusterResults", + "properties": { + "outputUri": { + "description": "Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiskConfig": { + "description": "Specifies the config of disk options for a group of VM instances.", + "id": "DiskConfig", + "properties": { + "bootDiskProvisionedIops": { + "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. Note: This field is only supported if boot_disk_type is hyperdisk-balanced.", + "format": "int64", + "type": "string" + }, + "bootDiskProvisionedThroughput": { + "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. Values must be greater than or equal to 1. Note: This field is only supported if boot_disk_type is hyperdisk-balanced.", + "format": "int64", + "type": "string" + }, + "bootDiskSizeGb": { + "description": "Optional. Size in GB of the boot disk (default is 500GB).", + "format": "int32", + "type": "integer" + }, + "bootDiskType": { + "description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).", + "type": "string" + }, + "localSsdInterface": { + "description": "Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).", + "type": "string" + }, + "numLocalSsds": { + "description": "Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DriverSchedulingConfig": { + "description": "Driver scheduling configuration.", + "id": "DriverSchedulingConfig", + "properties": { + "memoryMb": { + "description": "Required. The amount of memory in MB the driver is requesting.", + "format": "int32", + "type": "integer" + }, + "vcores": { + "description": "Required. The number of vCPUs the driver is requesting.", + "format": "int32", + "type": "integer" + } + }, + "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" + }, + "EncryptionConfig": { + "description": "Encryption settings for the cluster.", + "id": "EncryptionConfig", + "properties": { + "gcePdKmsKeyName": { + "description": "Optional. The Cloud KMS key resource name to use for persistent disk encryption for all instances in the cluster. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information.", + "type": "string" + }, + "kmsKey": { + "description": "Optional. The Cloud KMS key resource name to use for cluster persistent disk and job argument encryption. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information.When this key resource name is provided, the following job arguments of the following job types submitted to the cluster are encrypted using CMEK: FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries", + "type": "string" + } + }, + "type": "object" + }, + "EndpointConfig": { + "description": "Endpoint config for this cluster", + "id": "EndpointConfig", + "properties": { + "enableHttpPortAccess": { + "description": "Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.", + "type": "boolean" + }, + "httpPorts": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "EnvironmentConfig": { + "description": "Environment configuration for a workload.", + "id": "EnvironmentConfig", + "properties": { + "executionConfig": { + "$ref": "ExecutionConfig", + "description": "Optional. Execution configuration for a workload." + }, + "peripheralsConfig": { + "$ref": "PeripheralsConfig", + "description": "Optional. Peripherals configuration that workload has access to." + } + }, + "type": "object" + }, + "ExecutionConfig": { + "description": "Execution configuration for a workload.", + "id": "ExecutionConfig", + "properties": { + "idleTtl": { + "description": "Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.", + "format": "google-duration", + "type": "string" + }, + "kmsKey": { + "description": "Optional. The Cloud KMS key to use for encryption.", + "type": "string" + }, + "networkTags": { + "description": "Optional. Tags used for network traffic control.", + "items": { + "type": "string" + }, + "type": "array" + }, + "networkUri": { + "description": "Optional. Network URI to connect workload to.", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. Service account that used to execute workload.", + "type": "string" + }, + "stagingBucket": { + "description": "Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "type": "string" + }, + "subnetworkUri": { + "description": "Optional. Subnetwork URI to connect workload to.", + "type": "string" + }, + "ttl": { + "description": "Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ExecutorMetrics": { + "id": "ExecutorMetrics", + "properties": { + "metrics": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "type": "object" + } + }, + "type": "object" + }, + "ExecutorMetricsDistributions": { + "id": "ExecutorMetricsDistributions", + "properties": { + "diskBytesSpilled": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "failedTasks": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "inputBytes": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "inputRecords": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "killedTasks": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "memoryBytesSpilled": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "outputBytes": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "outputRecords": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "peakMemoryMetrics": { + "$ref": "ExecutorPeakMetricsDistributions" + }, + "quantiles": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "shuffleRead": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "shuffleReadRecords": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "shuffleWrite": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "shuffleWriteRecords": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "succeededTasks": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + }, + "taskTimeMillis": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExecutorPeakMetricsDistributions": { + "id": "ExecutorPeakMetricsDistributions", + "properties": { + "executorMetrics": { + "items": { + "$ref": "ExecutorMetrics" + }, + "type": "array" + }, + "quantiles": { + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExecutorResourceRequest": { + "description": "Resources used per executor used by the application.", + "id": "ExecutorResourceRequest", + "properties": { + "amount": { + "format": "int64", + "type": "string" + }, + "discoveryScript": { + "type": "string" + }, + "resourceName": { + "type": "string" + }, + "vendor": { + "type": "string" + } + }, + "type": "object" + }, + "ExecutorStageSummary": { + "description": "Executor resources consumed by a stage.", + "id": "ExecutorStageSummary", + "properties": { + "diskBytesSpilled": { + "format": "int64", + "type": "string" + }, + "executorId": { + "type": "string" + }, + "failedTasks": { + "format": "int32", + "type": "integer" + }, + "inputBytes": { + "format": "int64", + "type": "string" + }, + "inputRecords": { + "format": "int64", + "type": "string" + }, + "isExcludedForStage": { + "type": "boolean" + }, + "killedTasks": { + "format": "int32", + "type": "integer" + }, + "memoryBytesSpilled": { + "format": "int64", + "type": "string" + }, + "outputBytes": { + "format": "int64", + "type": "string" + }, + "outputRecords": { + "format": "int64", + "type": "string" + }, + "peakMemoryMetrics": { + "$ref": "ExecutorMetrics" + }, + "shuffleRead": { + "format": "int64", + "type": "string" + }, + "shuffleReadRecords": { + "format": "int64", + "type": "string" + }, + "shuffleWrite": { + "format": "int64", + "type": "string" + }, + "shuffleWriteRecords": { + "format": "int64", + "type": "string" + }, + "stageAttemptId": { + "format": "int32", + "type": "integer" + }, + "stageId": { + "format": "int64", + "type": "string" + }, + "succeededTasks": { + "format": "int32", + "type": "integer" + }, + "taskTimeMillis": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ExecutorSummary": { + "description": "Details about executors used by the application.", + "id": "ExecutorSummary", + "properties": { + "activeTasks": { + "format": "int32", + "type": "integer" + }, + "addTime": { + "format": "google-datetime", + "type": "string" + }, + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "completedTasks": { + "format": "int32", + "type": "integer" + }, + "diskUsed": { + "format": "int64", + "type": "string" + }, + "excludedInStages": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "executorId": { + "type": "string" + }, + "executorLogs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "failedTasks": { + "format": "int32", + "type": "integer" + }, + "hostPort": { + "type": "string" + }, + "isActive": { + "type": "boolean" + }, + "isExcluded": { + "type": "boolean" + }, + "maxMemory": { + "format": "int64", + "type": "string" + }, + "maxTasks": { + "format": "int32", + "type": "integer" + }, + "memoryMetrics": { + "$ref": "MemoryMetrics" + }, + "memoryUsed": { + "format": "int64", + "type": "string" + }, + "peakMemoryMetrics": { + "$ref": "ExecutorMetrics" + }, + "rddBlocks": { + "format": "int32", + "type": "integer" + }, + "removeReason": { + "type": "string" + }, + "removeTime": { + "format": "google-datetime", + "type": "string" + }, + "resourceProfileId": { + "format": "int32", + "type": "integer" + }, + "resources": { + "additionalProperties": { + "$ref": "ResourceInformation" + }, + "type": "object" + }, + "totalCores": { + "format": "int32", + "type": "integer" + }, + "totalDurationMillis": { + "format": "int64", + "type": "string" + }, + "totalGcTimeMillis": { + "format": "int64", + "type": "string" + }, + "totalInputBytes": { + "format": "int64", + "type": "string" + }, + "totalShuffleRead": { + "format": "int64", + "type": "string" + }, + "totalShuffleWrite": { + "format": "int64", + "type": "string" + }, + "totalTasks": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "FlinkJob": { + "description": "A Dataproc job for running Apache Flink applications on YARN.", + "id": "FlinkJob", + "properties": { + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission.", + "items": { + "type": "string" + }, + "type": "array" + }, + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.", + "items": { + "type": "string" + }, + "type": "array" + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "mainClass": { + "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.", + "type": "string" + }, + "mainJarFileUri": { + "description": "The HCFS URI of the jar file that contains the main class.", + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code.", + "type": "object" + }, + "savepointUri": { + "description": "Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.", + "type": "string" + } + }, + "type": "object" + }, + "GceClusterConfig": { + "description": "Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.", + "id": "GceClusterConfig", + "properties": { + "confidentialInstanceConfig": { + "$ref": "ConfidentialInstanceConfig", + "description": "Optional. Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs)." + }, + "internalIpOnly": { + "description": "Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.When set to true: All cluster VMs have internal IP addresses. Google Private Access (https://cloud.google.com/vpc/docs/private-google-access) must be enabled to access Dataproc and other Google Cloud APIs. Off-cluster dependencies must be configured to be accessible without external IP addresses.When set to false: Cluster VMs are not restricted to internal IP addresses. Ephemeral external IP addresses are assigned to each cluster VM.", + "type": "boolean" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", + "type": "object" + }, + "networkUri": { + "description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default", + "type": "string" + }, + "nodeGroupAffinity": { + "$ref": "NodeGroupAffinity", + "description": "Optional. Node Group Affinity for sole-tenant clusters." + }, + "privateIpv6GoogleAccess": { + "description": "Optional. The type of IPv6 access for a cluster.", + "enum": [ + "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", + "INHERIT_FROM_SUBNETWORK", + "OUTBOUND", + "BIDIRECTIONAL" + ], + "enumDescriptions": [ + "If unspecified, Compute Engine default behavior will apply, which is the same as INHERIT_FROM_SUBNETWORK.", + "Private access to and from Google Services configuration inherited from the subnetwork configuration. This is the default Compute Engine behavior.", + "Enables outbound private IPv6 access to Google Services from the Dataproc cluster.", + "Enables bidirectional private IPv6 access between Google Services and the Dataproc cluster." + ], + "type": "string" + }, + "reservationAffinity": { + "$ref": "ReservationAffinity", + "description": "Optional. Reservation Affinity for consuming Zonal reservation." + }, + "serviceAccount": { + "description": "Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", + "type": "string" + }, + "serviceAccountScopes": { + "description": "Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control", + "items": { + "type": "string" + }, + "type": "array" + }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm)." + }, + "subnetworkUri": { + "description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0 projects/[project_id]/regions/[region]/subnetworks/sub0 sub0", + "type": "string" + }, + "tags": { + "description": "The Compute Engine network tags to add to all instances (see Tagging instances (https://cloud.google.com/vpc/docs/add-remove-network-tags)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "zoneUri": { + "description": "Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone]", + "type": "string" + } + }, + "type": "object" + }, + "GetIamPolicyRequest": { + "description": "Request message for GetIamPolicy method.", + "id": "GetIamPolicyRequest", + "properties": { + "options": { + "$ref": "GetPolicyOptions", + "description": "OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy." + } + }, + "type": "object" + }, + "GetPolicyOptions": { + "description": "Encapsulates settings provided to GetIamPolicy.", + "id": "GetPolicyOptions", + "properties": { + "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", + "type": "integer" + } + }, + "type": "object" + }, + "GkeClusterConfig": { + "description": "The cluster's GKE config.", + "id": "GkeClusterConfig", + "properties": { + "gkeClusterTarget": { + "description": "Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'", + "type": "string" + }, + "namespacedGkeDeploymentTarget": { + "$ref": "NamespacedGkeDeploymentTarget", + "deprecated": true, + "description": "Optional. Deprecated. Use gkeClusterTarget. Used only for the deprecated beta. A target for the deployment." + }, + "nodePoolTarget": { + "description": "Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings.", + "items": { + "$ref": "GkeNodePoolTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "GkeNodeConfig": { + "description": "Parameters that describe cluster nodes.", + "id": "GkeNodeConfig", + "properties": { + "accelerators": { + "description": "Optional. A list of hardware accelerators (https://cloud.google.com/compute/docs/gpus) to attach to each node.", + "items": { + "$ref": "GkeNodePoolAcceleratorConfig" + }, + "type": "array" + }, + "bootDiskKmsKey": { + "description": "Optional. The Customer Managed Encryption Key (CMEK) (https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}", + "type": "string" + }, + "localSsdCount": { + "description": "Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs (https://cloud.google.com/compute/docs/disks/local-ssd)).", + "format": "int32", + "type": "integer" + }, + "machineType": { + "description": "Optional. The name of a Compute Engine machine type (https://cloud.google.com/compute/docs/machine-types).", + "type": "string" + }, + "minCpuPlatform": { + "description": "Optional. Minimum CPU platform (https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as \"Intel Haswell\"` or Intel Sandy Bridge\".", + "type": "string" + }, + "preemptible": { + "description": "Optional. Whether the nodes are created as legacy preemptible VM instances (https://cloud.google.com/compute/docs/instances/preemptible). Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).", + "type": "boolean" + }, + "spot": { + "description": "Optional. Whether the nodes are created as Spot VM instances (https://cloud.google.com/compute/docs/instances/spot). Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).", + "type": "boolean" + } + }, + "type": "object" + }, + "GkeNodePoolAcceleratorConfig": { + "description": "A GkeNodeConfigAcceleratorConfig represents a Hardware Accelerator request for a node pool.", + "id": "GkeNodePoolAcceleratorConfig", + "properties": { + "acceleratorCount": { + "description": "The number of accelerator cards exposed to an instance.", + "format": "int64", + "type": "string" + }, + "acceleratorType": { + "description": "The accelerator type resource namename (see GPUs on Compute Engine).", + "type": "string" + }, + "gpuPartitionSize": { + "description": "Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide (https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).", + "type": "string" + } + }, + "type": "object" + }, + "GkeNodePoolAutoscalingConfig": { + "description": "GkeNodePoolAutoscaling contains information the cluster autoscaler needs to adjust the size of the node pool to the current cluster usage.", + "id": "GkeNodePoolAutoscalingConfig", + "properties": { + "maxNodeCount": { + "description": "The maximum number of nodes in the node pool. Must be >= min_node_count, and must be > 0. Note: Quota must be sufficient to scale up the cluster.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "The minimum number of nodes in the node pool. Must be >= 0 and <= max_node_count.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GkeNodePoolConfig": { + "description": "The configuration of a GKE node pool used by a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster).", + "id": "GkeNodePoolConfig", + "properties": { + "autoscaling": { + "$ref": "GkeNodePoolAutoscalingConfig", + "description": "Optional. The autoscaler configuration for this node pool. The autoscaler is enabled only when a valid configuration is present." + }, + "config": { + "$ref": "GkeNodeConfig", + "description": "Optional. The node pool configuration." + }, + "locations": { + "description": "Optional. The list of Compute Engine zones (https://cloud.google.com/compute/docs/zones#available) where node pool nodes associated with a Dataproc on GKE virtual cluster will be located.Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region.If a location is not specified during node pool creation, Dataproc on GKE will choose the zone.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GkeNodePoolTarget": { + "description": "GKE node pools that Dataproc workloads run on.", + "id": "GkeNodePoolTarget", + "properties": { + "nodePool": { + "description": "Required. The target GKE node pool. Format: 'projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}'", + "type": "string" + }, + "nodePoolConfig": { + "$ref": "GkeNodePoolConfig", + "description": "Input only. The configuration for the GKE node pool.If specified, Dataproc attempts to create a node pool with the specified shape. If one with the same name already exists, it is verified against all specified fields. If a field differs, the virtual cluster creation will fail.If omitted, any node pool with the specified name is used. If a node pool with the specified name does not exist, Dataproc create a node pool with default values.This is an input only field. It will not be returned by the API." + }, + "roles": { + "description": "Required. The roles associated with the GKE node pool.", + "items": { + "enum": [ + "ROLE_UNSPECIFIED", + "DEFAULT", + "CONTROLLER", + "SPARK_DRIVER", + "SPARK_EXECUTOR" + ], + "enumDescriptions": [ + "Role is unspecified.", + "At least one node pool must have the DEFAULT role. Work assigned to a role that is not associated with a node pool is assigned to the node pool with the DEFAULT role. For example, work assigned to the CONTROLLER role will be assigned to the node pool with the DEFAULT role if no node pool has the CONTROLLER role.", + "Run work associated with the Dataproc control plane (for example, controllers and webhooks). Very low resource requirements.", + "Run work associated with a Spark driver of a job.", + "Run work associated with a Spark executor of a job." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig": { + "description": "Encryption settings for encrypting workflow template job arguments.", + "id": "GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig", + "properties": { + "kmsKey": { + "description": "Optional. The Cloud KMS key name to use for encrypting workflow template job arguments.When this this key is provided, the following workflow template job arguments (https://cloud.google.com/dataproc/docs/concepts/workflows/use-workflows#adding_jobs_to_a_template), if present, are CMEK encrypted (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_workflow_template_data): FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries", + "type": "string" + } + }, + "type": "object" + }, + "HadoopJob": { + "description": "A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", + "id": "HadoopJob", + "properties": { + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", + "items": { + "type": "string" + }, + "type": "array" + }, + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision might occur that causes an incorrect job submission.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fileUris": { + "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", + "items": { + "type": "string" + }, + "type": "array" + }, + "jarFileUris": { + "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", + "items": { + "type": "string" + }, + "type": "array" + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "mainClass": { + "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", + "type": "string" + }, + "mainJarFileUri": { + "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", + "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", + "type": "object" + } + }, + "type": "object" + }, + "HiveJob": { + "description": "A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", + "id": "HiveJob", + "properties": { + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", + "type": "boolean" + }, + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.", + "items": { + "type": "string" + }, + "type": "array" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", + "type": "object" + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains Hive queries.", + "type": "string" + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "scriptVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).", + "type": "object" + } + }, + "type": "object" + }, + "IdentityConfig": { + "description": "Identity related configuration, including service account based secure multi-tenancy user mappings.", + "id": "IdentityConfig", + "properties": { + "userServiceAccountMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Map of user to service account.", + "type": "object" + } + }, + "type": "object" + }, + "InjectCredentialsRequest": { + "description": "A request to inject credentials into a cluster.", + "id": "InjectCredentialsRequest", + "properties": { + "clusterUuid": { + "description": "Required. The cluster UUID.", + "type": "string" + }, + "credentialsCiphertext": { + "description": "Required. The encrypted credentials being injected in to the cluster.The client is responsible for encrypting the credentials in a way that is supported by the cluster.A wrapped value is used here so that the actual contents of the encrypted credentials are not written to audit logs.", + "type": "string" + } + }, + "type": "object" + }, + "InputMetrics": { + "description": "Metrics about the input data read by the task.", + "id": "InputMetrics", + "properties": { + "bytesRead": { + "format": "int64", + "type": "string" + }, + "recordsRead": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InputQuantileMetrics": { + "id": "InputQuantileMetrics", + "properties": { + "bytesRead": { + "$ref": "Quantiles" + }, + "recordsRead": { + "$ref": "Quantiles" + } + }, + "type": "object" + }, + "InstanceFlexibilityPolicy": { + "description": "Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.", + "id": "InstanceFlexibilityPolicy", + "properties": { + "instanceSelectionList": { + "description": "Optional. List of instance selection options that the group will use when creating new VMs.", + "items": { + "$ref": "InstanceSelection" + }, + "type": "array" + }, + "instanceSelectionResults": { + "description": "Output only. A list of instance selection results in the group.", + "items": { + "$ref": "InstanceSelectionResult" + }, + "readOnly": true, + "type": "array" + }, + "provisioningModelMix": { + "$ref": "ProvisioningModelMix", + "description": "Optional. Defines how the Group selects the provisioning model to ensure required reliability." + } + }, + "type": "object" + }, + "InstanceGroupAutoscalingPolicyConfig": { + "description": "Configuration for the size bounds of an instance group, including its proportional size to other groups.", + "id": "InstanceGroupAutoscalingPolicyConfig", + "properties": { + "maxInstances": { + "description": "Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Secondary workers - Bounds: [min_instances, ). Default: 0.", + "format": "int32", + "type": "integer" + }, + "minInstances": { + "description": "Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.", + "format": "int32", + "type": "integer" + }, + "weight": { + "description": "Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceGroupConfig": { + "description": "The config settings for Compute Engine resources in an instance group, such as a master or worker group.", + "id": "InstanceGroupConfig", + "properties": { + "accelerators": { + "description": "Optional. The Compute Engine accelerator configuration for these instances.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, + "diskConfig": { + "$ref": "DiskConfig", + "description": "Optional. Disk option config settings." + }, + "imageUri": { + "description": "Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.", + "type": "string" + }, + "instanceFlexibilityPolicy": { + "$ref": "InstanceFlexibilityPolicy", + "description": "Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models." + }, + "instanceNames": { + "description": "Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "instanceReferences": { + "description": "Output only. List of references to Compute Engine instances.", + "items": { + "$ref": "InstanceReference" + }, + "readOnly": true, + "type": "array" + }, + "isPreemptible": { + "description": "Output only. Specifies that this instance group contains preemptible instances.", + "readOnly": true, + "type": "boolean" + }, + "machineTypeUri": { + "description": "Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.", + "type": "string" + }, + "managedGroupConfig": { + "$ref": "ManagedGroupConfig", + "description": "Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.", + "readOnly": true + }, + "minCpuPlatform": { + "description": "Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).", + "type": "string" + }, + "minNumInstances": { + "description": "Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.", + "format": "int32", + "type": "integer" + }, + "numInstances": { + "description": "Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.", + "format": "int32", + "type": "integer" + }, + "preemptibility": { + "description": "Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.", + "enum": [ + "PREEMPTIBILITY_UNSPECIFIED", + "NON_PREEMPTIBLE", + "PREEMPTIBLE", + "SPOT" + ], + "enumDescriptions": [ + "Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.", + "Instances are non-preemptible.This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.", + "Instances are preemptible (https://cloud.google.com/compute/docs/instances/preemptible).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups.", + "Instances are Spot VMs (https://cloud.google.com/compute/docs/instances/spot).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups. Spot VMs are the latest version of preemptible VMs (https://cloud.google.com/compute/docs/instances/preemptible), and provide additional features." + ], + "type": "string" + }, + "startupConfig": { + "$ref": "StartupConfig", + "description": "Optional. Configuration to handle the startup of instances during cluster create and update process." + } + }, + "type": "object" + }, + "InstanceReference": { + "description": "A reference to a Compute Engine instance.", + "id": "InstanceReference", + "properties": { + "instanceId": { + "description": "The unique identifier of the Compute Engine instance.", + "type": "string" + }, + "instanceName": { + "description": "The user-friendly name of the Compute Engine instance.", + "type": "string" + }, + "publicEciesKey": { + "description": "The public ECIES key used for sharing data with this instance.", + "type": "string" + }, + "publicKey": { + "description": "The public RSA key used for sharing data with this instance.", + "type": "string" + } + }, + "type": "object" + }, + "InstanceSelection": { + "description": "Defines machines types and a rank to which the machines types belong.", + "id": "InstanceSelection", + "properties": { + "machineTypes": { + "description": "Optional. Full machine-type names, e.g. \"n1-standard-16\".", + "items": { + "type": "string" + }, + "type": "array" + }, + "rank": { + "description": "Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceSelectionResult": { + "description": "Defines a mapping from machine types to the number of VMs that are created with each machine type.", + "id": "InstanceSelectionResult", + "properties": { + "machineType": { + "description": "Output only. Full machine-type names, e.g. \"n1-standard-16\".", + "readOnly": true, + "type": "string" + }, + "vmCount": { + "description": "Output only. Number of VM provisioned with the machine_type.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "InstantiateWorkflowTemplateRequest": { + "description": "A request to instantiate a workflow template.", + "id": "InstantiateWorkflowTemplateRequest", + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.", + "type": "object" + }, + "requestId": { + "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + }, + "version": { + "description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Interval": { + "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", + "id": "Interval", + "properties": { + "endTime": { + "description": "Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "Job": { + "description": "A Dataproc job resource.", + "id": "Job", + "properties": { + "done": { + "description": "Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.", + "readOnly": true, + "type": "boolean" + }, + "driverControlFilesUri": { + "description": "Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as driver_output_uri.", + "readOnly": true, + "type": "string" + }, + "driverOutputResourceUri": { + "description": "Output only. A URI pointing to the location of the stdout of the job's driver program.", + "readOnly": true, + "type": "string" + }, + "driverSchedulingConfig": { + "$ref": "DriverSchedulingConfig", + "description": "Optional. Driver scheduling configuration." + }, + "flinkJob": { + "$ref": "FlinkJob", + "description": "Optional. Job is a Flink job." + }, + "hadoopJob": { + "$ref": "HadoopJob", + "description": "Optional. Job is a Hadoop job." + }, + "hiveJob": { + "$ref": "HiveJob", + "description": "Optional. Job is a Hive job." + }, + "jobUuid": { + "description": "Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", + "type": "object" + }, + "pigJob": { + "$ref": "PigJob", + "description": "Optional. Job is a Pig job." + }, + "placement": { + "$ref": "JobPlacement", + "description": "Required. Job information, including how, when, and where to run the job." + }, + "prestoJob": { + "$ref": "PrestoJob", + "description": "Optional. Job is a Presto job." + }, + "pysparkJob": { + "$ref": "PySparkJob", + "description": "Optional. Job is a PySpark job." + }, + "reference": { + "$ref": "JobReference", + "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id." + }, + "scheduling": { + "$ref": "JobScheduling", + "description": "Optional. Job scheduling configuration." + }, + "sparkJob": { + "$ref": "SparkJob", + "description": "Optional. Job is a Spark job." + }, + "sparkRJob": { + "$ref": "SparkRJob", + "description": "Optional. Job is a SparkR job." + }, + "sparkSqlJob": { + "$ref": "SparkSqlJob", + "description": "Optional. Job is a SparkSql job." + }, + "status": { + "$ref": "JobStatus", + "description": "Output only. The job status. Additional application-specific status information might be contained in the type_job and yarn_applications fields.", + "readOnly": true + }, + "statusHistory": { + "description": "Output only. The previous job status.", + "items": { + "$ref": "JobStatus" + }, + "readOnly": true, + "type": "array" + }, + "trinoJob": { + "$ref": "TrinoJob", + "description": "Optional. Job is a Trino job." + }, + "yarnApplications": { + "description": "Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release.", + "items": { + "$ref": "YarnApplication" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "JobData": { + "description": "Data corresponding to a spark job.", + "id": "JobData", + "properties": { + "completionTime": { + "format": "google-datetime", + "type": "string" + }, + "description": { + "type": "string" + }, + "jobGroup": { + "type": "string" + }, + "jobId": { + "format": "int64", + "type": "string" + }, + "killTasksSummary": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" + }, + "name": { + "type": "string" + }, + "numActiveStages": { + "format": "int32", + "type": "integer" + }, + "numActiveTasks": { + "format": "int32", + "type": "integer" + }, + "numCompletedIndices": { + "format": "int32", + "type": "integer" + }, + "numCompletedStages": { + "format": "int32", + "type": "integer" + }, + "numCompletedTasks": { + "format": "int32", + "type": "integer" + }, + "numFailedStages": { + "format": "int32", + "type": "integer" + }, + "numFailedTasks": { + "format": "int32", + "type": "integer" + }, + "numKilledTasks": { + "format": "int32", + "type": "integer" + }, + "numSkippedStages": { + "format": "int32", + "type": "integer" + }, + "numSkippedTasks": { + "format": "int32", + "type": "integer" + }, + "numTasks": { + "format": "int32", + "type": "integer" + }, + "skippedStages": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "sqlExecutionId": { + "format": "int64", + "type": "string" + }, + "stageIds": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "status": { + "enum": [ + "JOB_EXECUTION_STATUS_UNSPECIFIED", + "JOB_EXECUTION_STATUS_RUNNING", + "JOB_EXECUTION_STATUS_SUCCEEDED", + "JOB_EXECUTION_STATUS_FAILED", + "JOB_EXECUTION_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "submissionTime": { + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "JobMetadata": { + "description": "Job Operation metadata.", + "id": "JobMetadata", + "properties": { + "jobId": { + "description": "Output only. The job id.", + "readOnly": true, + "type": "string" + }, + "operationType": { + "description": "Output only. Operation type.", + "readOnly": true, + "type": "string" + }, + "startTime": { + "description": "Output only. Job submission time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "JobStatus", + "description": "Output only. Most recent job status.", + "readOnly": true } - } - } - }, - "revision": "20240821", - "rootUrl": "https://dataproc.googleapis.com/", - "schemas": { - "AcceleratorConfig": { - "description": "Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).", - "id": "AcceleratorConfig", + }, + "type": "object" + }, + "JobPlacement": { + "description": "Dataproc job config.", + "id": "JobPlacement", "properties": { - "acceleratorCount": { - "description": "The number of the accelerator cards of this type exposed to this instance.", - "format": "int32", - "type": "integer" + "clusterLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Cluster labels to identify a cluster where the job will be submitted.", + "type": "object" }, - "acceleratorTypeUri": { - "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/v1/acceleratorTypes).Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 projects/[project_id]/zones/[zone]/acceleratorTypes/nvidia-tesla-t4 nvidia-tesla-t4Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-t4.", + "clusterName": { + "description": "Required. The name of the cluster where the job will be submitted.", + "type": "string" + }, + "clusterUuid": { + "description": "Output only. A cluster UUID generated by the Dataproc service when the job is submitted.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "AnalyzeBatchRequest": { - "description": "A request to analyze a batch workload.", - "id": "AnalyzeBatchRequest", + "JobReference": { + "description": "Encapsulates the full scoping used to reference a job.", + "id": "JobReference", "properties": { - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the service receives two AnalyzeBatchRequest (http://cloud/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.AnalyzeBatchRequest)s with the same request_id, the second request is ignored and the Operation that corresponds to the first request created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "jobId": { + "description": "Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.", + "type": "string" + }, + "projectId": { + "description": "Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.", "type": "string" } }, "type": "object" }, - "AnalyzeOperationMetadata": { - "description": "Metadata describing the Analyze operation.", - "id": "AnalyzeOperationMetadata", + "JobScheduling": { + "description": "Job scheduling options.", + "id": "JobScheduling", "properties": { - "analyzedWorkloadName": { - "description": "Output only. name of the workload being analyzed.", + "maxFailuresPerHour": { + "description": "Optional. Maximum number of times per hour a driver can be restarted as a result of driver exiting with non-zero code before job is reported failed.A job might be reported as thrashing if the driver exits with a non-zero code four times within a 10-minute window.Maximum value is 10.Note: This restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template).", + "format": "int32", + "type": "integer" + }, + "maxFailuresTotal": { + "description": "Optional. Maximum total number of times a driver can be restarted as a result of the driver exiting with a non-zero code. After the maximum number is reached, the job will be reported as failed.Maximum value is 240.Note: Currently, this restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "JobStatus": { + "description": "Dataproc job status.", + "id": "JobStatus", + "properties": { + "details": { + "description": "Optional. Output only. Job state details, such as an error description if the state is ERROR.", "readOnly": true, "type": "string" }, - "analyzedWorkloadType": { - "description": "Output only. Type of the workload being analyzed.", + "state": { + "description": "Output only. A state message specifying the overall job state.", "enum": [ - "WORKLOAD_TYPE_UNSPECIFIED", - "BATCH" + "STATE_UNSPECIFIED", + "PENDING", + "SETUP_DONE", + "RUNNING", + "CANCEL_PENDING", + "CANCEL_STARTED", + "CANCELLED", + "DONE", + "ERROR", + "ATTEMPT_FAILURE" ], "enumDescriptions": [ - "Undefined option", - "Serverless batch job" + "The job state is unknown.", + "The job is pending; it has been submitted, but is not yet running.", + "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.", + "The job is running on the cluster.", + "A CancelJob request has been received, but is pending.", + "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.", + "The job cancellation was successful.", + "The job has completed successfully.", + "The job has completed, but encountered an error.", + "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only." ], "readOnly": true, "type": "string" }, - "analyzedWorkloadUuid": { - "description": "Output only. unique identifier of the workload typically generated by control plane. E.g. batch uuid.", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. The time when the operation was created.", + "stateStartTime": { + "description": "Output only. The time when this state was entered.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "description": { - "description": "Output only. Short description of the operation.", + "substate": { + "description": "Output only. Additional state information, which includes status reported by the agent.", + "enum": [ + "UNSPECIFIED", + "SUBMITTED", + "QUEUED", + "STALE_STATUS" + ], + "enumDescriptions": [ + "The job substate is unknown.", + "The Job is submitted to the agent.Applies to RUNNING state.", + "The Job has been received and is awaiting execution (it might be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.", + "The agent-reported status is out of date, which can be caused by a loss of communication between the agent and Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state." + ], "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "JobsSummary": { + "description": "Data related to Jobs page summary", + "id": "JobsSummary", + "properties": { + "activeJobs": { + "description": "Number of active jobs", + "format": "int32", + "type": "integer" }, - "doneTime": { - "description": "Output only. The time when the operation finished.", - "format": "google-datetime", - "readOnly": true, + "applicationId": { + "description": "Spark Application Id", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Output only. Labels associated with the operation.", - "readOnly": true, - "type": "object" - }, - "warnings": { - "description": "Output only. Warnings encountered during operation execution.", + "attempts": { + "description": "Attempts info", "items": { - "type": "string" + "$ref": "ApplicationAttemptInfo" }, - "readOnly": true, "type": "array" + }, + "completedJobs": { + "description": "Number of completed jobs", + "format": "int32", + "type": "integer" + }, + "failedJobs": { + "description": "Number of failed jobs", + "format": "int32", + "type": "integer" + }, + "schedulingMode": { + "description": "Spark Scheduling mode", + "type": "string" + } + }, + "type": "object" + }, + "JupyterConfig": { + "description": "Jupyter configuration for an interactive session.", + "id": "JupyterConfig", + "properties": { + "displayName": { + "description": "Optional. Display name, shown in the Jupyter kernelspec card.", + "type": "string" + }, + "kernel": { + "description": "Optional. Kernel", + "enum": [ + "KERNEL_UNSPECIFIED", + "PYTHON", + "SCALA" + ], + "enumDescriptions": [ + "The kernel is unknown.", + "Python kernel.", + "Scala kernel." + ], + "type": "string" + } + }, + "type": "object" + }, + "KerberosConfig": { + "description": "Specifies Kerberos related configuration.", + "id": "KerberosConfig", + "properties": { + "crossRealmTrustAdminServer": { + "description": "Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.", + "type": "string" + }, + "crossRealmTrustKdc": { + "description": "Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.", + "type": "string" + }, + "crossRealmTrustRealm": { + "description": "Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.", + "type": "string" + }, + "crossRealmTrustSharedPasswordUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.", + "type": "string" + }, + "enableKerberos": { + "description": "Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.", + "type": "boolean" + }, + "kdcDbKeyUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.", + "type": "string" + }, + "keyPasswordUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.", + "type": "string" + }, + "keystorePasswordUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.", + "type": "string" + }, + "keystoreUri": { + "description": "Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.", + "type": "string" + }, + "kmsKeyUri": { + "description": "Optional. The URI of the KMS key used to encrypt sensitive files.", + "type": "string" + }, + "realm": { + "description": "Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.", + "type": "string" + }, + "rootPrincipalPasswordUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.", + "type": "string" + }, + "tgtLifetimeHours": { + "description": "Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.", + "format": "int32", + "type": "integer" + }, + "truststorePasswordUri": { + "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.", + "type": "string" + }, + "truststoreUri": { + "description": "Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.", + "type": "string" } }, "type": "object" }, - "AutoscalingConfig": { - "description": "Autoscaling Policy config associated with the cluster.", - "id": "AutoscalingConfig", + "KubernetesClusterConfig": { + "description": "The configuration for running the Dataproc cluster on Kubernetes.", + "id": "KubernetesClusterConfig", "properties": { - "policyUri": { - "description": "Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.", + "gkeClusterConfig": { + "$ref": "GkeClusterConfig", + "description": "Required. The configuration for running the Dataproc cluster on GKE." + }, + "kubernetesNamespace": { + "description": "Optional. A namespace within the Kubernetes cluster to deploy into. If this namespace does not exist, it is created. If it exists, Dataproc verifies that another Dataproc VirtualCluster is not installed into it. If not specified, the name of the Dataproc Cluster is used.", "type": "string" + }, + "kubernetesSoftwareConfig": { + "$ref": "KubernetesSoftwareConfig", + "description": "Optional. The software configuration for this Dataproc cluster running on Kubernetes." } }, "type": "object" }, - "AutoscalingPolicy": { - "description": "Describes an autoscaling policy for Dataproc cluster autoscaler.", - "id": "AutoscalingPolicy", + "KubernetesSoftwareConfig": { + "description": "The software configuration for this Dataproc cluster running on Kubernetes.", + "id": "KubernetesSoftwareConfig", "properties": { - "basicAlgorithm": { - "$ref": "BasicAutoscalingAlgorithm" - }, - "id": { - "description": "Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.", - "type": "string" - }, - "labels": { + "componentVersion": { "additionalProperties": { "type": "string" }, - "description": "Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with an autoscaling policy.", + "description": "The components that should be installed in this Dataproc cluster. The key must be a string from the KubernetesComponent enumeration. The value is the version of the software to be installed. At least one entry must be specified.", "type": "object" }, - "name": { - "description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}", - "readOnly": true, - "type": "string" - }, - "secondaryWorkerConfig": { - "$ref": "InstanceGroupAutoscalingPolicyConfig", - "description": "Optional. Describes how the autoscaler will operate for secondary workers." - }, - "workerConfig": { - "$ref": "InstanceGroupAutoscalingPolicyConfig", - "description": "Required. Describes how the autoscaler will operate for primary workers." - } - }, - "type": "object" - }, - "AutotuningConfig": { - "description": "Autotuning configuration of the workload.", - "id": "AutotuningConfig", - "properties": { - "scenarios": { - "description": "Optional. Scenarios for which tunings are applied.", - "items": { - "enum": [ - "SCENARIO_UNSPECIFIED", - "SCALING", - "BROADCAST_HASH_JOIN", - "MEMORY" - ], - "enumDescriptions": [ - "Default value.", - "Scaling recommendations such as initialExecutors.", - "Adding hints for potential relation broadcasts.", - "Memory management for workloads." - ], + "properties": { + "additionalProperties": { "type": "string" }, - "type": "array" + "description": "The properties to set on daemon config files.Property keys are specified in prefix:property format, for example spark:spark.kubernetes.container.image. The following are supported prefixes and their mappings: spark: spark-defaults.confFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).", + "type": "object" } }, "type": "object" }, - "AuxiliaryNodeGroup": { - "description": "Node group identification and configuration information.", - "id": "AuxiliaryNodeGroup", + "LifecycleConfig": { + "description": "Specifies the cluster auto-delete schedule configuration.", + "id": "LifecycleConfig", "properties": { - "nodeGroup": { - "$ref": "NodeGroup", - "description": "Required. Node group configuration." - }, - "nodeGroupId": { - "description": "Optional. A node group ID. Generated if not specified.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of from 3 to 33 characters.", + "autoDeleteTime": { + "description": "Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "AuxiliaryServicesConfig": { - "description": "Auxiliary services configuration for a Cluster.", - "id": "AuxiliaryServicesConfig", - "properties": { - "metastoreConfig": { - "$ref": "MetastoreConfig", - "description": "Optional. The Hive Metastore configuration for this workload." }, - "sparkHistoryServerConfig": { - "$ref": "SparkHistoryServerConfig", - "description": "Optional. The Spark History Server configuration for the workload." - } - }, - "type": "object" - }, - "BasicAutoscalingAlgorithm": { - "description": "Basic algorithm for autoscaling.", - "id": "BasicAutoscalingAlgorithm", - "properties": { - "cooldownPeriod": { - "description": "Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.", + "autoDeleteTtl": { + "description": "Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", "format": "google-duration", "type": "string" }, - "sparkStandaloneConfig": { - "$ref": "SparkStandaloneAutoscalingConfig", - "description": "Optional. Spark Standalone autoscaling configuration" - }, - "yarnConfig": { - "$ref": "BasicYarnAutoscalingConfig", - "description": "Optional. YARN autoscaling configuration." - } - }, - "type": "object" - }, - "BasicYarnAutoscalingConfig": { - "description": "Basic autoscaling configurations for YARN.", - "id": "BasicYarnAutoscalingConfig", - "properties": { - "gracefulDecommissionTimeout": { - "description": "Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations.Bounds: 0s, 1d.", + "idleDeleteTtl": { + "description": "Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", "format": "google-duration", "type": "string" }, - "scaleDownFactor": { - "description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. See How autoscaling works (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.", - "format": "double", - "type": "number" - }, - "scaleDownMinWorkerFraction": { - "description": "Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", - "format": "double", - "type": "number" - }, - "scaleUpFactor": { - "description": "Required. Fraction of average YARN pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). See How autoscaling works (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.", - "format": "double", - "type": "number" - }, - "scaleUpMinWorkerFraction": { - "description": "Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", - "format": "double", - "type": "number" + "idleStartTime": { + "description": "Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "Batch": { - "description": "A representation of a batch workload in the service.", - "id": "Batch", + "ListAutoscalingPoliciesResponse": { + "description": "A response to a request to list autoscaling policies in a project.", + "id": "ListAutoscalingPoliciesResponse", "properties": { - "createTime": { - "description": "Output only. The time when the batch was created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "creator": { - "description": "Output only. The email address of the user who created the batch.", + "nextPageToken": { + "description": "Output only. This token is included in the response if there are more results to fetch.", "readOnly": true, "type": "string" }, - "environmentConfig": { - "$ref": "EnvironmentConfig", - "description": "Optional. Environment configuration for the batch execution." - }, - "labels": { - "additionalProperties": { - "type": "string" + "policies": { + "description": "Output only. Autoscaling policies list.", + "items": { + "$ref": "AutoscalingPolicy" }, - "description": "Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch.", - "type": "object" - }, - "name": { - "description": "Output only. The resource name of the batch.", - "readOnly": true, - "type": "string" - }, - "operation": { - "description": "Output only. The resource name of the operation associated with this batch.", - "readOnly": true, - "type": "string" - }, - "pysparkBatch": { - "$ref": "PySparkBatch", - "description": "Optional. PySpark batch config." - }, - "runtimeConfig": { - "$ref": "RuntimeConfig", - "description": "Optional. Runtime configuration for the batch execution." - }, - "runtimeInfo": { - "$ref": "RuntimeInfo", - "description": "Output only. Runtime information about batch execution.", - "readOnly": true - }, - "sparkBatch": { - "$ref": "SparkBatch", - "description": "Optional. Spark batch config." - }, - "sparkRBatch": { - "$ref": "SparkRBatch", - "description": "Optional. SparkR batch config." - }, - "sparkSqlBatch": { - "$ref": "SparkSqlBatch", - "description": "Optional. SparkSql batch config." - }, - "state": { - "description": "Output only. The state of the batch.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "CANCELLING", - "CANCELLED", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "The batch state is unknown.", - "The batch is created before running.", - "The batch is running.", - "The batch is cancelling.", - "The batch cancellation was successful.", - "The batch completed successfully.", - "The batch is no longer running due to an error." - ], "readOnly": true, - "type": "string" - }, - "stateHistory": { - "description": "Output only. Historical state information for the batch.", + "type": "array" + } + }, + "type": "object" + }, + "ListBatchesResponse": { + "description": "A list of batch workloads.", + "id": "ListBatchesResponse", + "properties": { + "batches": { + "description": "Output only. The batches from the specified collection.", "items": { - "$ref": "StateHistory" + "$ref": "Batch" }, "readOnly": true, "type": "array" }, - "stateMessage": { - "description": "Output only. Batch state details, such as a failure description if the state is FAILED.", - "readOnly": true, + "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" }, - "stateTime": { - "description": "Output only. The time when the batch entered a current state.", - "format": "google-datetime", + "unreachable": { + "description": "Output only. List of Batches that could not be included in the response. Attempting to get one of these resources may indicate why it was not included in the list response.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" + } + }, + "type": "object" + }, + "ListClustersResponse": { + "description": "The list of all clusters in a project.", + "id": "ListClustersResponse", + "properties": { + "clusters": { + "description": "Output only. The clusters in the project.", + "items": { + "$ref": "Cluster" + }, + "readOnly": true, + "type": "array" }, - "uuid": { - "description": "Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch.", + "nextPageToken": { + "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.", "readOnly": true, "type": "string" } }, "type": "object" }, - "BatchOperationMetadata": { - "description": "Metadata describing the Batch operation.", - "id": "BatchOperationMetadata", + "ListJobsResponse": { + "description": "A list of jobs in a project.", + "id": "ListJobsResponse", "properties": { - "batch": { - "description": "Name of the batch for the operation.", - "type": "string" - }, - "batchUuid": { - "description": "Batch UUID for the operation.", - "type": "string" + "jobs": { + "description": "Output only. Jobs list.", + "items": { + "$ref": "Job" + }, + "readOnly": true, + "type": "array" }, - "createTime": { - "description": "The time when the operation was created.", - "format": "google-datetime", + "nextPageToken": { + "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListJobsRequest.", "type": "string" }, - "description": { - "description": "Short description of the operation.", + "unreachable": { + "description": "Output only. List of jobs with kms_key-encrypted parameters that could not be decrypted. A response to a jobs.get request may indicate the reason for the decryption failure for a specific job.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", "type": "string" }, - "doneTime": { - "description": "The time when the operation finished.", - "format": "google-datetime", + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSessionTemplatesResponse": { + "description": "A list of session templates.", + "id": "ListSessionTemplatesResponse", + "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" }, - "labels": { - "additionalProperties": { - "type": "string" + "sessionTemplates": { + "description": "Output only. Session template list", + "items": { + "$ref": "SessionTemplate" }, - "description": "Labels associated with the operation.", - "type": "object" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "BATCH_OPERATION_TYPE_UNSPECIFIED", - "BATCH" - ], - "enumDescriptions": [ - "Batch operation type is unknown.", - "Batch operation type." - ], + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "ListSessionsResponse": { + "description": "A list of interactive sessions.", + "id": "ListSessionsResponse", + "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" }, - "warnings": { - "description": "Warnings encountered during operation execution.", + "sessions": { + "description": "Output only. The sessions from the specified collection.", "items": { - "type": "string" + "$ref": "Session" }, + "readOnly": true, "type": "array" } }, "type": "object" }, - "Binding": { - "description": "Associates members, or principals, with a role.", - "id": "Binding", + "ListWorkflowTemplatesResponse": { + "description": "A response to a request to list workflow templates in a project.", + "id": "ListWorkflowTemplatesResponse", "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)." + "nextPageToken": { + "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListWorkflowTemplatesRequest.", + "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.", + "templates": { + "description": "Output only. WorkflowTemplates list.", "items": { - "type": "string" + "$ref": "WorkflowTemplate" }, + "readOnly": true, "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" + "unreachable": { + "description": "Output only. List of workflow templates that could not be included in the response. Attempting to get one of these resources may indicate why it was not included in the list response.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "CancelJobRequest": { - "description": "A request to cancel a job.", - "id": "CancelJobRequest", - "properties": {}, + "LoggingConfig": { + "description": "The runtime logging config of the job.", + "id": "LoggingConfig", + "properties": { + "driverLogLevels": { + "additionalProperties": { + "enum": [ + "LEVEL_UNSPECIFIED", + "ALL", + "TRACE", + "DEBUG", + "INFO", + "WARN", + "ERROR", + "FATAL", + "OFF" + ], + "enumDescriptions": [ + "Level is unspecified. Use default level for log4j.", + "Use ALL level for log4j.", + "Use TRACE level for log4j.", + "Use DEBUG level for log4j.", + "Use INFO level for log4j.", + "Use WARN level for log4j.", + "Use ERROR level for log4j.", + "Use FATAL level for log4j.", + "Turn off log4j." + ], + "type": "string" + }, + "description": "The per-package log levels for the driver. This can include \"root\" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG'", + "type": "object" + } + }, "type": "object" }, - "Cluster": { - "description": "Describes the identifying information, config, and status of a Dataproc cluster", - "id": "Cluster", + "ManagedCluster": { + "description": "Cluster that is managed by the workflow.", + "id": "ManagedCluster", "properties": { "clusterName": { - "description": "Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused.", - "type": "string" - }, - "clusterUuid": { - "description": "Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.", - "readOnly": true, + "description": "Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.", "type": "string" }, "config": { "$ref": "ClusterConfig", - "description": "Optional. The cluster config for a cluster of Compute Engine Instances. Note that Dataproc may set default values, and values may change when clusters are updated.Exactly one of ClusterConfig or VirtualClusterConfig must be specified." + "description": "Required. The cluster configuration." }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.", + "description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.", "type": "object" - }, - "metrics": { - "$ref": "ClusterMetrics", - "description": "Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "readOnly": true - }, - "projectId": { - "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", - "type": "string" - }, - "status": { - "$ref": "ClusterStatus", - "description": "Output only. Cluster status.", - "readOnly": true - }, - "statusHistory": { - "description": "Output only. The previous cluster status.", - "items": { - "$ref": "ClusterStatus" - }, + } + }, + "type": "object" + }, + "ManagedGroupConfig": { + "description": "Specifies the resources used to actively manage an instance group.", + "id": "ManagedGroupConfig", + "properties": { + "instanceGroupManagerName": { + "description": "Output only. The name of the Instance Group Manager for this group.", "readOnly": true, - "type": "array" + "type": "string" }, - "virtualClusterConfig": { - "$ref": "VirtualClusterConfig", - "description": "Optional. The virtual cluster config is used when creating a Dataproc cluster that does not directly control the underlying compute resources, for example, when creating a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). Dataproc may set default values, and values may change when clusters are updated. Exactly one of config or virtual_cluster_config must be specified." + "instanceGroupManagerUri": { + "description": "Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.", + "readOnly": true, + "type": "string" + }, + "instanceTemplateName": { + "description": "Output only. The name of the Instance Template used for the Managed Instance Group.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ClusterConfig": { - "description": "The cluster config.", - "id": "ClusterConfig", + "MemoryMetrics": { + "id": "MemoryMetrics", "properties": { - "autoscalingConfig": { - "$ref": "AutoscalingConfig", - "description": "Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset." - }, - "auxiliaryNodeGroups": { - "description": "Optional. The node group settings.", - "items": { - "$ref": "AuxiliaryNodeGroup" - }, - "type": "array" - }, - "configBucket": { - "description": "Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "totalOffHeapStorageMemory": { + "format": "int64", "type": "string" }, - "dataprocMetricConfig": { - "$ref": "DataprocMetricConfig", - "description": "Optional. The config for Dataproc metrics." - }, - "encryptionConfig": { - "$ref": "EncryptionConfig", - "description": "Optional. Encryption settings for the cluster." - }, - "endpointConfig": { - "$ref": "EndpointConfig", - "description": "Optional. Port/endpoint configuration for this cluster" - }, - "gceClusterConfig": { - "$ref": "GceClusterConfig", - "description": "Optional. The shared Compute Engine config settings for all instances in a cluster." + "totalOnHeapStorageMemory": { + "format": "int64", + "type": "string" }, - "gkeClusterConfig": { - "$ref": "GkeClusterConfig", - "deprecated": true, - "description": "Optional. BETA. The Kubernetes Engine config for Dataproc clusters deployed to The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. These config settings are mutually exclusive with Compute Engine-based options, such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config." + "usedOffHeapStorageMemory": { + "format": "int64", + "type": "string" }, - "initializationActions": { - "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi ", + "usedOnHeapStorageMemory": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "MetastoreConfig": { + "description": "Specifies a Metastore configuration.", + "id": "MetastoreConfig", + "properties": { + "dataprocMetastoreService": { + "description": "Required. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name]", + "type": "string" + } + }, + "type": "object" + }, + "Metric": { + "description": "A Dataproc custom metric.", + "id": "Metric", + "properties": { + "metricOverrides": { + "description": "Optional. Specify one or more Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) to collect for the metric course (for the SPARK metric source (any Spark metric (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be specified).Provide metrics in the following format: METRIC_SOURCE: INSTANCE:GROUP:METRIC Use camelcase as appropriate.Examples: yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.used Notes: Only the specified overridden metrics are collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.", "items": { - "$ref": "NodeInitializationAction" + "type": "string" }, "type": "array" }, - "lifecycleConfig": { - "$ref": "LifecycleConfig", - "description": "Optional. Lifecycle setting for the cluster." - }, - "masterConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Compute Engine config settings for the cluster's master instance." - }, - "metastoreConfig": { - "$ref": "MetastoreConfig", - "description": "Optional. Metastore configuration." - }, - "secondaryWorkerConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Compute Engine config settings for a cluster's secondary worker instances" - }, - "securityConfig": { - "$ref": "SecurityConfig", - "description": "Optional. Security settings for the cluster." - }, - "softwareConfig": { - "$ref": "SoftwareConfig", - "description": "Optional. The config settings for cluster software." - }, - "tempBucket": { - "description": "Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket (see Dataproc staging and temp buckets (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)). This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "metricSource": { + "description": "Required. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) for more information).", + "enum": [ + "METRIC_SOURCE_UNSPECIFIED", + "MONITORING_AGENT_DEFAULTS", + "HDFS", + "SPARK", + "YARN", + "SPARK_HISTORY_SERVER", + "HIVESERVER2", + "HIVEMETASTORE", + "FLINK" + ], + "enumDescriptions": [ + "Required unspecified metric source.", + "Monitoring agent metrics. If this source is enabled, Dataproc enables the monitoring agent in Compute Engine, and collects monitoring agent metrics, which are published with an agent.googleapis.com prefix.", + "HDFS metric source.", + "Spark metric source.", + "YARN metric source.", + "Spark History Server metric source.", + "Hiveserver2 metric source.", + "hivemetastore metric source", + "flink metric source" + ], + "type": "string" + } + }, + "type": "object" + }, + "NamespacedGkeDeploymentTarget": { + "deprecated": true, + "description": "Deprecated. Used only for the deprecated beta. A full, namespace-isolated deployment target for an existing GKE cluster.", + "id": "NamespacedGkeDeploymentTarget", + "properties": { + "clusterNamespace": { + "description": "Optional. A namespace within the GKE cluster to deploy into.", "type": "string" }, - "workerConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Compute Engine config settings for the cluster's worker instances." + "targetGkeCluster": { + "description": "Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'", + "type": "string" } }, "type": "object" }, - "ClusterMetrics": { - "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "id": "ClusterMetrics", + "NodeGroup": { + "description": "Dataproc Node Group. The Dataproc NodeGroup resource is not related to the Dataproc NodeGroupAffinity resource.", + "id": "NodeGroup", "properties": { - "hdfsMetrics": { + "labels": { "additionalProperties": { - "format": "int64", "type": "string" }, - "description": "The HDFS metrics.", + "description": "Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labels.", "type": "object" }, - "yarnMetrics": { - "additionalProperties": { - "format": "int64", + "name": { + "description": "The Node group resource name (https://aip.dev/122).", + "type": "string" + }, + "nodeGroupConfig": { + "$ref": "InstanceGroupConfig", + "description": "Optional. The node group instance group configuration." + }, + "roles": { + "description": "Required. Node group roles.", + "items": { + "enum": [ + "ROLE_UNSPECIFIED", + "DRIVER" + ], + "enumDescriptions": [ + "Required unspecified role.", + "Job drivers run on the node pool." + ], "type": "string" }, - "description": "YARN metrics.", - "type": "object" + "type": "array" } }, "type": "object" }, - "ClusterOperation": { - "description": "The cluster operation triggered by a workflow.", - "id": "ClusterOperation", + "NodeGroupAffinity": { + "description": "Node Group Affinity for clusters using sole-tenant node groups. The Dataproc NodeGroupAffinity resource is not related to the Dataproc NodeGroup resource.", + "id": "NodeGroupAffinity", "properties": { - "done": { - "description": "Output only. Indicates the operation is done.", - "readOnly": true, - "type": "boolean" - }, - "error": { - "description": "Output only. Error, if operation failed.", - "readOnly": true, - "type": "string" - }, - "operationId": { - "description": "Output only. The id of the cluster operation.", - "readOnly": true, + "nodeGroupUri": { + "description": "Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1", "type": "string" } }, "type": "object" }, - "ClusterOperationMetadata": { - "description": "Metadata describing the operation.", - "id": "ClusterOperationMetadata", + "NodeGroupOperationMetadata": { + "description": "Metadata describing the node group operation.", + "id": "NodeGroupOperationMetadata", "properties": { - "childOperationIds": { - "description": "Output only. Child operation ids", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "clusterName": { - "description": "Output only. Name of the cluster for the operation.", - "readOnly": true, - "type": "string" - }, "clusterUuid": { - "description": "Output only. Cluster UUID for the operation.", + "description": "Output only. Cluster UUID associated with the node group operation.", "readOnly": true, "type": "string" }, @@ -3728,15 +8531,41 @@ "additionalProperties": { "type": "string" }, - "description": "Output only. Labels associated with the operation", + "description": "Output only. Labels associated with the operation.", "readOnly": true, "type": "object" }, - "operationType": { - "description": "Output only. The operation type.", + "nodeGroupId": { + "description": "Output only. Node group ID for the operation.", "readOnly": true, "type": "string" }, + "operationType": { + "description": "The operation type.", + "enum": [ + "NODE_GROUP_OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "UPDATE", + "DELETE", + "RESIZE", + "REPAIR", + "UPDATE_LABELS", + "START", + "STOP" + ], + "enumDescriptions": [ + "Node group operation type is unknown.", + "Create node group operation type.", + "Update node group operation type.", + "Delete node group operation type.", + "Resize node group operation type.", + "Repair node group operation type.", + "Update node group label operation type.", + "Start node group operation type.", + "Stop node group operation type." + ], + "type": "string" + }, "status": { "$ref": "ClusterOperationStatus", "description": "Output only. Current operation status.", @@ -3761,405 +8590,474 @@ }, "type": "object" }, - "ClusterOperationStatus": { - "description": "The status of the operation.", - "id": "ClusterOperationStatus", + "NodeInitializationAction": { + "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", + "id": "NodeInitializationAction", "properties": { - "details": { - "description": "Output only. A message containing any operation metadata details.", - "readOnly": true, - "type": "string" - }, - "innerState": { - "description": "Output only. A message containing the detailed operation state.", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "Output only. A message containing the operation state.", - "enum": [ - "UNKNOWN", - "PENDING", - "RUNNING", - "DONE" - ], - "enumDescriptions": [ - "Unused.", - "The operation has been created.", - "The operation is running.", - "The operation is done; either cancelled or completed." - ], - "readOnly": true, - "type": "string" - }, - "stateStartTime": { - "description": "Output only. The time this state was entered.", - "format": "google-datetime", - "readOnly": true, + "executableFile": { + "description": "Required. Cloud Storage URI of executable file.", "type": "string" - } - }, - "type": "object" - }, - "ClusterSelector": { - "description": "A selector that chooses target cluster for jobs based on metadata.", - "id": "ClusterSelector", - "properties": { - "clusterLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "Required. The cluster labels. Cluster must have all labels to match.", - "type": "object" }, - "zone": { - "description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.", + "executionTimeout": { + "description": "Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.", + "format": "google-duration", "type": "string" } }, "type": "object" }, - "ClusterStatus": { - "description": "The status of a cluster and its instances.", - "id": "ClusterStatus", + "NodePool": { + "description": "indicating a list of workers of same type", + "id": "NodePool", "properties": { - "detail": { - "description": "Optional. Output only. Details of cluster's state.", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "Output only. The cluster's state.", - "enum": [ - "UNKNOWN", - "CREATING", - "RUNNING", - "ERROR", - "ERROR_DUE_TO_UPDATE", - "DELETING", - "UPDATING", - "STOPPING", - "STOPPED", - "STARTING", - "REPAIRING" - ], - "enumDescriptions": [ - "The cluster state is unknown.", - "The cluster is being created and set up. It is not ready for use.", - "The cluster is currently running and healthy. It is ready for use.Note: The cluster state changes from \"creating\" to \"running\" status after the master node(s), first two primary worker nodes (and the last primary worker node if primary workers > 2) are running.", - "The cluster encountered an error. It is not ready for use.", - "The cluster has encountered an error while being updated. Jobs can be submitted to the cluster, but the cluster cannot be updated.", - "The cluster is being deleted. It cannot be used.", - "The cluster is being updated. It continues to accept and process jobs.", - "The cluster is being stopped. It cannot be used.", - "The cluster is currently stopped. It is not ready for use.", - "The cluster is being started. It is not ready for use.", - "The cluster is being repaired. It is not ready for use." - ], - "readOnly": true, + "id": { + "description": "Required. A unique id of the node pool. Primary and Secondary workers can be specified using special reserved ids PRIMARY_WORKER_POOL and SECONDARY_WORKER_POOL respectively. Aux node pools can be referenced using corresponding pool id.", "type": "string" }, - "stateStartTime": { - "description": "Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "instanceNames": { + "description": "Name of instances to be repaired. These instances must belong to specified node pool.", + "items": { + "type": "string" + }, + "type": "array" }, - "substate": { - "description": "Output only. Additional state information that includes status reported by the agent.", + "repairAction": { + "description": "Required. Repair action to take on specified resources of the node pool.", "enum": [ - "UNSPECIFIED", - "UNHEALTHY", - "STALE_STATUS" + "REPAIR_ACTION_UNSPECIFIED", + "DELETE" ], "enumDescriptions": [ - "The cluster substate is unknown.", - "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.", - "The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state." + "No action will be taken by default.", + "delete the specified list of nodes." ], - "readOnly": true, "type": "string" } }, "type": "object" }, - "ConfidentialInstanceConfig": { - "description": "Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs)", - "id": "ConfidentialInstanceConfig", + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", "properties": { - "enableConfidentialCompute": { - "description": "Optional. Defines whether the instance should have confidential compute enabled.", + "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" - } - }, - "type": "object" - }, - "DataprocMetricConfig": { - "description": "Dataproc metric config.", - "id": "DataprocMetricConfig", - "properties": { - "metrics": { - "description": "Required. Metrics sources to enable.", - "items": { - "$ref": "Metric" + }, + "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" }, - "type": "array" + "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" }, - "DiagnoseClusterRequest": { - "description": "A request to collect cluster diagnostic information.", - "id": "DiagnoseClusterRequest", + "OrderedJob": { + "description": "A job executed by the workflow.", + "id": "OrderedJob", "properties": { - "diagnosisInterval": { - "$ref": "Interval", - "description": "Optional. Time interval in which diagnosis should be carried out on the cluster." + "flinkJob": { + "$ref": "FlinkJob", + "description": "Optional. Job is a Flink job." }, - "job": { - "deprecated": true, - "description": "Optional. DEPRECATED Specifies the job on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}", - "type": "string" + "hadoopJob": { + "$ref": "HadoopJob", + "description": "Optional. Job is a Hadoop job." }, - "jobs": { - "description": "Optional. Specifies a list of jobs on which diagnosis is to be performed. Format: projects/{project}/regions/{region}/jobs/{job}", + "hiveJob": { + "$ref": "HiveJob", + "description": "Optional. Job is a Hive job." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given job.", + "type": "object" + }, + "pigJob": { + "$ref": "PigJob", + "description": "Optional. Job is a Pig job." + }, + "prerequisiteStepIds": { + "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.", "items": { "type": "string" }, "type": "array" }, - "tarballAccess": { - "description": "Optional. (Optional) The access type to the diagnostic tarball. If not specified, falls back to default access of the bucket", - "enum": [ - "TARBALL_ACCESS_UNSPECIFIED", - "GOOGLE_CLOUD_SUPPORT", - "GOOGLE_DATAPROC_DIAGNOSE" - ], - "enumDescriptions": [ - "Tarball Access unspecified. Falls back to default access of the bucket", - "Google Cloud Support group has read access to the diagnostic tarball", - "Google Cloud Dataproc Diagnose service account has read access to the diagnostic tarball" - ], + "prestoJob": { + "$ref": "PrestoJob", + "description": "Optional. Job is a Presto job." + }, + "pysparkJob": { + "$ref": "PySparkJob", + "description": "Optional. Job is a PySpark job." + }, + "scheduling": { + "$ref": "JobScheduling", + "description": "Optional. Job scheduling configuration." + }, + "sparkJob": { + "$ref": "SparkJob", + "description": "Optional. Job is a Spark job." + }, + "sparkRJob": { + "$ref": "SparkRJob", + "description": "Optional. Job is a SparkR job." + }, + "sparkSqlJob": { + "$ref": "SparkSqlJob", + "description": "Optional. Job is a SparkSql job." + }, + "stepId": { + "description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.", + "type": "string" + }, + "trinoJob": { + "$ref": "TrinoJob", + "description": "Optional. Job is a Trino job." + } + }, + "type": "object" + }, + "OutputMetrics": { + "description": "Metrics about the data written by the task.", + "id": "OutputMetrics", + "properties": { + "bytesWritten": { + "format": "int64", "type": "string" }, - "tarballGcsDir": { - "description": "Optional. (Optional) The output Cloud Storage directory for the diagnostic tarball. If not specified, a task-specific directory in the cluster's staging bucket will be used.", + "recordsWritten": { + "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "OutputQuantileMetrics": { + "id": "OutputQuantileMetrics", + "properties": { + "bytesWritten": { + "$ref": "Quantiles" }, - "yarnApplicationId": { - "deprecated": true, - "description": "Optional. DEPRECATED Specifies the yarn application on which diagnosis is to be performed.", - "type": "string" + "recordsWritten": { + "$ref": "Quantiles" + } + }, + "type": "object" + }, + "ParameterValidation": { + "description": "Configuration for parameter validation.", + "id": "ParameterValidation", + "properties": { + "regex": { + "$ref": "RegexValidation", + "description": "Validation based on regular expressions." }, - "yarnApplicationIds": { - "description": "Optional. Specifies a list of yarn applications on which diagnosis is to be performed.", - "items": { - "type": "string" - }, - "type": "array" + "values": { + "$ref": "ValueValidation", + "description": "Validation based on a list of allowed values." } }, "type": "object" }, - "DiagnoseClusterResults": { - "description": "The location of diagnostic output.", - "id": "DiagnoseClusterResults", + "PeripheralsConfig": { + "description": "Auxiliary services configuration for a workload.", + "id": "PeripheralsConfig", "properties": { - "outputUri": { - "description": "Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.", - "readOnly": true, + "metastoreService": { + "description": "Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]", "type": "string" + }, + "sparkHistoryServerConfig": { + "$ref": "SparkHistoryServerConfig", + "description": "Optional. The Spark History Server configuration for the workload." } }, "type": "object" }, - "DiskConfig": { - "description": "Specifies the config of disk options for a group of VM instances.", - "id": "DiskConfig", + "PigJob": { + "description": "A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", + "id": "PigJob", "properties": { - "bootDiskProvisionedIops": { - "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. Note: This field is only supported if boot_disk_type is hyperdisk-balanced.", - "format": "int64", - "type": "string" + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", + "type": "boolean" }, - "bootDiskProvisionedThroughput": { - "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. Values must be greater than or equal to 1. Note: This field is only supported if boot_disk_type is hyperdisk-balanced.", - "format": "int64", - "type": "string" + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", + "items": { + "type": "string" + }, + "type": "array" }, - "bootDiskSizeGb": { - "description": "Optional. Size in GB of the boot disk (default is 500GB).", - "format": "int32", - "type": "integer" + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." }, - "bootDiskType": { - "description": "Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-balanced\" (Persistent Disk Balanced Solid State Drive), \"pd-ssd\" (Persistent Disk Solid State Drive), or \"pd-standard\" (Persistent Disk Hard Disk Drive). See Disk types (https://cloud.google.com/compute/docs/disks#disk-types).", - "type": "string" + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", + "type": "object" }, - "localSsdInterface": { - "description": "Optional. Interface type of local SSDs (default is \"scsi\"). Valid values: \"scsi\" (Small Computer System Interface), \"nvme\" (Non-Volatile Memory Express). See local SSD performance (https://cloud.google.com/compute/docs/disks/local-ssd#performance).", + "queryFileUri": { + "description": "The HCFS URI of the script that contains the Pig queries.", "type": "string" }, - "numLocalSsds": { - "description": "Optional. Number of attached SSDs, from 0 to 8 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.Note: Local SSD options may vary by machine type and number of vCPUs selected.", - "format": "int32", - "type": "integer" + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "scriptVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).", + "type": "object" } }, "type": "object" }, - "DriverSchedulingConfig": { - "description": "Driver scheduling configuration.", - "id": "DriverSchedulingConfig", + "Policy": { + "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).", + "id": "Policy", "properties": { - "memoryMb": { - "description": "Required. The amount of memory in MB the driver is requesting.", - "format": "int32", - "type": "integer" + "bindings": { + "description": "Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.", + "items": { + "$ref": "Binding" + }, + "type": "array" }, - "vcores": { - "description": "Required. The number of vCPUs the driver is requesting.", + "etag": { + "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: 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" }, - "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" - }, - "EncryptionConfig": { - "description": "Encryption settings for the cluster.", - "id": "EncryptionConfig", + "PoolData": { + "description": "Pool Data", + "id": "PoolData", "properties": { - "gcePdKmsKeyName": { - "description": "Optional. The Cloud KMS key resource name to use for persistent disk encryption for all instances in the cluster. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information.", + "name": { "type": "string" }, - "kmsKey": { - "description": "Optional. The Cloud KMS key resource name to use for cluster persistent disk and job argument encryption. See Use CMEK with cluster data (https://cloud.google.com//dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_cluster_data) for more information.When this key resource name is provided, the following job arguments of the following job types submitted to the cluster are encrypted using CMEK: FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries", - "type": "string" + "stageIds": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "EndpointConfig": { - "description": "Endpoint config for this cluster", - "id": "EndpointConfig", + "PrestoJob": { + "description": "A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster.", + "id": "PrestoJob", "properties": { - "enableHttpPortAccess": { - "description": "Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.", + "clientTags": { + "description": "Optional. Presto client tags to attach to this query", + "items": { + "type": "string" + }, + "type": "array" + }, + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", "type": "boolean" }, - "httpPorts": { + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "outputFormat": { + "description": "Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats", + "type": "string" + }, + "properties": { "additionalProperties": { "type": "string" }, - "description": "Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.", - "readOnly": true, + "description": "Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI", "type": "object" - } - }, - "type": "object" - }, - "EnvironmentConfig": { - "description": "Environment configuration for a workload.", - "id": "EnvironmentConfig", - "properties": { - "executionConfig": { - "$ref": "ExecutionConfig", - "description": "Optional. Execution configuration for a workload." }, - "peripheralsConfig": { - "$ref": "PeripheralsConfig", - "description": "Optional. Peripherals configuration that workload has access to." + "queryFileUri": { + "description": "The HCFS URI of the script that contains SQL queries.", + "type": "string" + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." } }, "type": "object" }, - "ExecutionConfig": { - "description": "Execution configuration for a workload.", - "id": "ExecutionConfig", + "ProcessSummary": { + "description": "Process Summary", + "id": "ProcessSummary", "properties": { - "idleTtl": { - "description": "Optional. Applies to sessions only. The duration to keep the session alive while it's idling. Exceeding this threshold causes the session to terminate. This field cannot be set on a batch workload. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). Defaults to 1 hour if not set. If both ttl and idle_ttl are specified for an interactive session, the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.", - "format": "google-duration", + "addTime": { + "format": "google-datetime", "type": "string" }, - "kmsKey": { - "description": "Optional. The Cloud KMS key to use for encryption.", + "hostPort": { "type": "string" }, - "networkTags": { - "description": "Optional. Tags used for network traffic control.", - "items": { - "type": "string" - }, - "type": "array" + "isActive": { + "type": "boolean" }, - "networkUri": { - "description": "Optional. Network URI to connect workload to.", + "processId": { "type": "string" }, - "serviceAccount": { - "description": "Optional. Service account that used to execute workload.", - "type": "string" + "processLogs": { + "additionalProperties": { + "type": "string" + }, + "type": "object" }, - "stagingBucket": { - "description": "Optional. A Cloud Storage bucket used to stage workload dependencies, config files, and store workload output and other ephemeral data, such as Spark history files. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location according to the region where your workload is running, and then create and manage project-level, per-location staging and temporary buckets. This field requires a Cloud Storage bucket name, not a gs://... URI to a Cloud Storage bucket.", + "removeTime": { + "format": "google-datetime", "type": "string" }, - "subnetworkUri": { - "description": "Optional. Subnetwork URI to connect workload to.", - "type": "string" + "totalCores": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ProvisioningModelMix": { + "description": "Defines how Dataproc should create VMs with a mixture of provisioning models.", + "id": "ProvisioningModelMix", + "properties": { + "standardCapacityBase": { + "description": "Optional. The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity you need. Dataproc will create only standard VMs until it reaches standard_capacity_base, then it will start using standard_capacity_percent_above_base to mix Spot with Standard VMs. eg. If 15 instances are requested and standard_capacity_base is 5, Dataproc will create 5 standard VMs and then start mixing spot and standard VMs for remaining 10 instances.", + "format": "int32", + "type": "integer" }, - "ttl": { - "description": "Optional. The duration after which the workload will be terminated, specified as the JSON representation for Duration (https://protobuf.dev/programming-guides/proto3/#json). When the workload exceeds this duration, it will be unconditionally terminated without waiting for ongoing work to finish. If ttl is not specified for a batch workload, the workload will be allowed to run until it exits naturally (or run forever without exiting). If ttl is not specified for an interactive session, it defaults to 24 hours. If ttl is not specified for a batch that uses 2.1+ runtime version, it defaults to 4 hours. Minimum value is 10 minutes; maximum value is 14 days. If both ttl and idle_ttl are specified (for an interactive session), the conditions are treated as OR conditions: the workload will be terminated when it has been idle for idle_ttl or when ttl has been exceeded, whichever occurs first.", - "format": "google-duration", + "standardCapacityPercentAboveBase": { + "description": "Optional. The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standard_capacity_base. eg. If 15 instances are requested and standard_capacity_base is 5 and standard_capacity_percent_above_base is 30, Dataproc will create 5 standard VMs and then start mixing spot and standard VMs for remaining 10 instances. The mix will be 30% standard and 70% spot.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "PyPiRepositoryConfig": { + "description": "Configuration for PyPi repository", + "id": "PyPiRepositoryConfig", + "properties": { + "pypiRepository": { + "description": "Optional. PyPi repository address", "type": "string" } }, "type": "object" }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", + "PySparkBatch": { + "description": "A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload.", + "id": "PySparkBatch", "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" + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + }, + "type": "array" }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", + "items": { + "type": "string" + }, + "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.", - "type": "string" + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", + "items": { + "type": "string" + }, + "type": "array" }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mainPythonFileUri": { + "description": "Required. The HCFS URI of the main Python file to use as the Spark driver. Must be a .py file.", "type": "string" + }, + "pythonFileUris": { + "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "FlinkJob": { - "description": "A Dataproc job for running Apache Flink applications on YARN.", - "id": "FlinkJob", + "PySparkJob": { + "description": "A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.", + "id": "PySparkJob", "properties": { + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + }, + "type": "array" + }, "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision might occur that causes an incorrect job submission.", + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", "items": { "type": "string" }, "type": "array" }, "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Flink driver and tasks.", + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", "items": { "type": "string" }, @@ -4169,244 +9067,302 @@ "$ref": "LoggingConfig", "description": "Optional. The runtime log config for job execution." }, - "mainClass": { - "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jarFileUris.", - "type": "string" - }, - "mainJarFileUri": { - "description": "The HCFS URI of the jar file that contains the main class.", + "mainPythonFileUri": { + "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.", "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might beoverwritten. Can include properties set in/etc/flink/conf/flink-defaults.conf and classes in user code.", + "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", "type": "object" }, - "savepointUri": { - "description": "Optional. HCFS URI of the savepoint, which contains the last saved progress for starting the current job.", - "type": "string" + "pythonFileUris": { + "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GceClusterConfig": { - "description": "Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.", - "id": "GceClusterConfig", + "Quantiles": { + "description": "Quantile metrics data related to Tasks. Units can be seconds, bytes, milliseconds, etc depending on the message type.", + "id": "Quantiles", "properties": { - "confidentialInstanceConfig": { - "$ref": "ConfidentialInstanceConfig", - "description": "Optional. Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs)." - }, - "internalIpOnly": { - "description": "Optional. This setting applies to subnetwork-enabled networks. It is set to true by default in clusters created with image versions 2.2.x.When set to true: All cluster VMs have internal IP addresses. Google Private Access (https://cloud.google.com/vpc/docs/private-google-access) must be enabled to access Dataproc and other Google Cloud APIs. Off-cluster dependencies must be configured to be accessible without external IP addresses.When set to false: Cluster VMs are not restricted to internal IP addresses. Ephemeral external IP addresses are assigned to each cluster VM.", - "type": "boolean" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", - "type": "object" + "count": { + "format": "int64", + "type": "string" }, - "networkUri": { - "description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default", + "maximum": { + "format": "int64", "type": "string" }, - "nodeGroupAffinity": { - "$ref": "NodeGroupAffinity", - "description": "Optional. Node Group Affinity for sole-tenant clusters." + "minimum": { + "format": "int64", + "type": "string" }, - "privateIpv6GoogleAccess": { - "description": "Optional. The type of IPv6 access for a cluster.", - "enum": [ - "PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", - "INHERIT_FROM_SUBNETWORK", - "OUTBOUND", - "BIDIRECTIONAL" - ], - "enumDescriptions": [ - "If unspecified, Compute Engine default behavior will apply, which is the same as INHERIT_FROM_SUBNETWORK.", - "Private access to and from Google Services configuration inherited from the subnetwork configuration. This is the default Compute Engine behavior.", - "Enables outbound private IPv6 access to Google Services from the Dataproc cluster.", - "Enables bidirectional private IPv6 access between Google Services and the Dataproc cluster." - ], + "percentile25": { + "format": "int64", "type": "string" }, - "reservationAffinity": { - "$ref": "ReservationAffinity", - "description": "Optional. Reservation Affinity for consuming Zonal reservation." + "percentile50": { + "format": "int64", + "type": "string" }, - "serviceAccount": { - "description": "Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", + "percentile75": { + "format": "int64", "type": "string" }, - "serviceAccountScopes": { - "description": "Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included: https://www.googleapis.com/auth/cloud.useraccounts.readonly https://www.googleapis.com/auth/devstorage.read_write https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigtable.admin.table https://www.googleapis.com/auth/bigtable.data https://www.googleapis.com/auth/devstorage.full_control", + "sum": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "QueryList": { + "description": "A list of queries to run on a cluster.", + "id": "QueryList", + "properties": { + "queries": { + "description": "Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: \"hiveJob\": { \"queryList\": { \"queries\": [ \"query1\", \"query2\", \"query3;query4\", ] } } ", "items": { "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "RddDataDistribution": { + "description": "Details about RDD usage.", + "id": "RddDataDistribution", + "properties": { + "address": { + "type": "string" }, - "shieldedInstanceConfig": { - "$ref": "ShieldedInstanceConfig", - "description": "Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm)." + "diskUsed": { + "format": "int64", + "type": "string" }, - "subnetworkUri": { - "description": "Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/[region]/subnetworks/sub0 projects/[project_id]/regions/[region]/subnetworks/sub0 sub0", + "memoryRemaining": { + "format": "int64", "type": "string" }, - "tags": { - "description": "The Compute Engine network tags to add to all instances (see Tagging instances (https://cloud.google.com/vpc/docs/add-remove-network-tags)).", - "items": { - "type": "string" - }, - "type": "array" + "memoryUsed": { + "format": "int64", + "type": "string" }, - "zoneUri": { - "description": "Optional. The Compute Engine zone where the Dataproc cluster will be located. If omitted, the service will pick a zone in the cluster's Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] projects/[project_id]/zones/[zone] [zone]", + "offHeapMemoryRemaining": { + "format": "int64", + "type": "string" + }, + "offHeapMemoryUsed": { + "format": "int64", + "type": "string" + }, + "onHeapMemoryRemaining": { + "format": "int64", + "type": "string" + }, + "onHeapMemoryUsed": { + "format": "int64", "type": "string" } }, "type": "object" }, - "GetIamPolicyRequest": { - "description": "Request message for GetIamPolicy method.", - "id": "GetIamPolicyRequest", + "RddOperationCluster": { + "description": "A grouping of nodes representing higher level constructs (stage, job etc.).", + "id": "RddOperationCluster", "properties": { - "options": { - "$ref": "GetPolicyOptions", - "description": "OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy." + "childClusters": { + "items": { + "$ref": "RddOperationCluster" + }, + "type": "array" + }, + "childNodes": { + "items": { + "$ref": "RddOperationNode" + }, + "type": "array" + }, + "name": { + "type": "string" + }, + "rddClusterId": { + "type": "string" } }, "type": "object" }, - "GetPolicyOptions": { - "description": "Encapsulates settings provided to GetIamPolicy.", - "id": "GetPolicyOptions", + "RddOperationEdge": { + "description": "A directed edge representing dependency between two RDDs.", + "id": "RddOperationEdge", "properties": { - "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).", + "fromId": { + "format": "int32", + "type": "integer" + }, + "toId": { "format": "int32", "type": "integer" } }, "type": "object" }, - "GkeClusterConfig": { - "description": "The cluster's GKE config.", - "id": "GkeClusterConfig", + "RddOperationGraph": { + "description": "Graph representing RDD dependencies. Consists of edges and a root cluster.", + "id": "RddOperationGraph", "properties": { - "gkeClusterTarget": { - "description": "Optional. A target GKE cluster to deploy to. It must be in the same project and region as the Dataproc cluster (the GKE cluster can be zonal or regional). Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'", - "type": "string" - }, - "namespacedGkeDeploymentTarget": { - "$ref": "NamespacedGkeDeploymentTarget", - "deprecated": true, - "description": "Optional. Deprecated. Use gkeClusterTarget. Used only for the deprecated beta. A target for the deployment." + "edges": { + "items": { + "$ref": "RddOperationEdge" + }, + "type": "array" }, - "nodePoolTarget": { - "description": "Optional. GKE node pools where workloads will be scheduled. At least one node pool must be assigned the DEFAULT GkeNodePoolTarget.Role. If a GkeNodePoolTarget is not specified, Dataproc constructs a DEFAULT GkeNodePoolTarget. Each role can be given to only one GkeNodePoolTarget. All node pools must have the same location settings.", + "incomingEdges": { "items": { - "$ref": "GkeNodePoolTarget" + "$ref": "RddOperationEdge" }, "type": "array" - } - }, - "type": "object" - }, - "GkeNodeConfig": { - "description": "Parameters that describe cluster nodes.", - "id": "GkeNodeConfig", - "properties": { - "accelerators": { - "description": "Optional. A list of hardware accelerators (https://cloud.google.com/compute/docs/gpus) to attach to each node.", + }, + "outgoingEdges": { "items": { - "$ref": "GkeNodePoolAcceleratorConfig" + "$ref": "RddOperationEdge" }, "type": "array" }, - "bootDiskKmsKey": { - "description": "Optional. The Customer Managed Encryption Key (CMEK) (https://cloud.google.com/kubernetes-engine/docs/how-to/using-cmek) used to encrypt the boot disk attached to each node in the node pool. Specify the key using the following format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}", + "rootCluster": { + "$ref": "RddOperationCluster" + }, + "stageId": { + "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "RddOperationNode": { + "description": "A node in the RDD operation graph. Corresponds to a single RDD.", + "id": "RddOperationNode", + "properties": { + "barrier": { + "type": "boolean" }, - "localSsdCount": { - "description": "Optional. The number of local SSD disks to attach to the node, which is limited by the maximum number of disks allowable per zone (see Adding Local SSDs (https://cloud.google.com/compute/docs/disks/local-ssd)).", - "format": "int32", - "type": "integer" + "cached": { + "type": "boolean" }, - "machineType": { - "description": "Optional. The name of a Compute Engine machine type (https://cloud.google.com/compute/docs/machine-types).", + "callsite": { "type": "string" }, - "minCpuPlatform": { - "description": "Optional. Minimum CPU platform (https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) to be used by this instance. The instance may be scheduled on the specified or a newer CPU platform. Specify the friendly names of CPU platforms, such as \"Intel Haswell\"` or Intel Sandy Bridge\".", + "name": { "type": "string" }, - "preemptible": { - "description": "Optional. Whether the nodes are created as legacy preemptible VM instances (https://cloud.google.com/compute/docs/instances/preemptible). Also see Spot VMs, preemptible VM instances without a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).", - "type": "boolean" + "nodeId": { + "format": "int32", + "type": "integer" }, - "spot": { - "description": "Optional. Whether the nodes are created as Spot VM instances (https://cloud.google.com/compute/docs/instances/spot). Spot VMs are the latest update to legacy preemptible VMs. Spot VMs do not have a maximum lifetime. Legacy and Spot preemptible nodes cannot be used in a node pool with the CONTROLLER role or in the DEFAULT node pool if the CONTROLLER role is not assigned (the DEFAULT node pool will assume the CONTROLLER role).", - "type": "boolean" + "outputDeterministicLevel": { + "enum": [ + "DETERMINISTIC_LEVEL_UNSPECIFIED", + "DETERMINISTIC_LEVEL_DETERMINATE", + "DETERMINISTIC_LEVEL_UNORDERED", + "DETERMINISTIC_LEVEL_INDETERMINATE" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" }, - "GkeNodePoolAcceleratorConfig": { - "description": "A GkeNodeConfigAcceleratorConfig represents a Hardware Accelerator request for a node pool.", - "id": "GkeNodePoolAcceleratorConfig", + "RddPartitionInfo": { + "description": "Information about RDD partitions.", + "id": "RddPartitionInfo", "properties": { - "acceleratorCount": { - "description": "The number of accelerator cards exposed to an instance.", + "blockName": { + "type": "string" + }, + "diskUsed": { "format": "int64", "type": "string" }, - "acceleratorType": { - "description": "The accelerator type resource namename (see GPUs on Compute Engine).", + "executors": { + "items": { + "type": "string" + }, + "type": "array" + }, + "memoryUsed": { + "format": "int64", "type": "string" }, - "gpuPartitionSize": { - "description": "Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide (https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).", + "storageLevel": { "type": "string" } }, "type": "object" }, - "GkeNodePoolAutoscalingConfig": { - "description": "GkeNodePoolAutoscaling contains information the cluster autoscaler needs to adjust the size of the node pool to the current cluster usage.", - "id": "GkeNodePoolAutoscalingConfig", + "RddStorageInfo": { + "description": "Overall data about RDD storage.", + "id": "RddStorageInfo", "properties": { - "maxNodeCount": { - "description": "The maximum number of nodes in the node pool. Must be >= min_node_count, and must be > 0. Note: Quota must be sufficient to scale up the cluster.", + "dataDistribution": { + "items": { + "$ref": "RddDataDistribution" + }, + "type": "array" + }, + "diskUsed": { + "format": "int64", + "type": "string" + }, + "memoryUsed": { + "format": "int64", + "type": "string" + }, + "name": { + "type": "string" + }, + "numCachedPartitions": { "format": "int32", "type": "integer" }, - "minNodeCount": { - "description": "The minimum number of nodes in the node pool. Must be >= 0 and <= max_node_count.", + "numPartitions": { + "format": "int32", + "type": "integer" + }, + "partitions": { + "items": { + "$ref": "RddPartitionInfo" + }, + "type": "array" + }, + "rddStorageId": { "format": "int32", "type": "integer" + }, + "storageLevel": { + "type": "string" } }, "type": "object" }, - "GkeNodePoolConfig": { - "description": "The configuration of a GKE node pool used by a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster).", - "id": "GkeNodePoolConfig", + "RegexValidation": { + "description": "Validation based on regular expressions.", + "id": "RegexValidation", "properties": { - "autoscaling": { - "$ref": "GkeNodePoolAutoscalingConfig", - "description": "Optional. The autoscaler configuration for this node pool. The autoscaler is enabled only when a valid configuration is present." - }, - "config": { - "$ref": "GkeNodeConfig", - "description": "Optional. The node pool configuration." - }, - "locations": { - "description": "Optional. The list of Compute Engine zones (https://cloud.google.com/compute/docs/zones#available) where node pool nodes associated with a Dataproc on GKE virtual cluster will be located.Note: All node pools associated with a virtual cluster must be located in the same region as the virtual cluster, and they must be located in the same zone within that region.If a location is not specified during node pool creation, Dataproc on GKE will choose the zone.", + "regexes": { + "description": "Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).", "items": { "type": "string" }, @@ -4415,191 +9371,314 @@ }, "type": "object" }, - "GkeNodePoolTarget": { - "description": "GKE node pools that Dataproc workloads run on.", - "id": "GkeNodePoolTarget", + "RepairClusterRequest": { + "description": "A request to repair a cluster.", + "id": "RepairClusterRequest", "properties": { - "nodePool": { - "description": "Required. The target GKE node pool. Format: 'projects/{project}/locations/{location}/clusters/{cluster}/nodePools/{node_pool}'", + "cluster": { + "$ref": "ClusterToRepair", + "description": "Optional. Cluster to be repaired" + }, + "clusterUuid": { + "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", "type": "string" }, - "nodePoolConfig": { - "$ref": "GkeNodePoolConfig", - "description": "Input only. The configuration for the GKE node pool.If specified, Dataproc attempts to create a node pool with the specified shape. If one with the same name already exists, it is verified against all specified fields. If a field differs, the virtual cluster creation will fail.If omitted, any node pool with the specified name is used. If a node pool with the specified name does not exist, Dataproc create a node pool with default values.This is an input only field. It will not be returned by the API." + "gracefulDecommissionTimeout": { + "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning facilitates the removal of cluster nodes without interrupting jobs in progress. The timeout specifies the amount of time to wait for jobs finish before forcefully removing nodes. The default timeout is 0 for forceful decommissioning, and the maximum timeout period is 1 day. (see JSON Mapping—Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).graceful_decommission_timeout is supported in Dataproc image versions 1.2+.", + "format": "google-duration", + "type": "string" }, - "roles": { - "description": "Required. The roles associated with the GKE node pool.", + "nodePools": { + "description": "Optional. Node pools and corresponding repair action to be taken. All node pools should be unique in this request. i.e. Multiple entries for the same node pool id are not allowed.", "items": { - "enum": [ - "ROLE_UNSPECIFIED", - "DEFAULT", - "CONTROLLER", - "SPARK_DRIVER", - "SPARK_EXECUTOR" - ], - "enumDescriptions": [ - "Role is unspecified.", - "At least one node pool must have the DEFAULT role. Work assigned to a role that is not associated with a node pool is assigned to the node pool with the DEFAULT role. For example, work assigned to the CONTROLLER role will be assigned to the node pool with the DEFAULT role if no node pool has the CONTROLLER role.", - "Run work associated with the Dataproc control plane (for example, controllers and webhooks). Very low resource requirements.", - "Run work associated with a Spark driver of a job.", - "Run work associated with a Spark executor of a job." - ], - "type": "string" + "$ref": "NodePool" }, "type": "array" + }, + "parentOperationId": { + "description": "Optional. operation id of the parent operation sending the repair request", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two RepairClusterRequests with the same ID, the second request is ignored, and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig": { - "description": "Encryption settings for encrypting workflow template job arguments.", - "id": "GoogleCloudDataprocV1WorkflowTemplateEncryptionConfig", + "RepairNodeGroupRequest": { + "id": "RepairNodeGroupRequest", "properties": { - "kmsKey": { - "description": "Optional. The Cloud KMS key name to use for encrypting workflow template job arguments.When this this key is provided, the following workflow template job arguments (https://cloud.google.com/dataproc/docs/concepts/workflows/use-workflows#adding_jobs_to_a_template), if present, are CMEK encrypted (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/customer-managed-encryption#use_cmek_with_workflow_template_data): FlinkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/FlinkJob) HadoopJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/HadoopJob) SparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkJob) SparkRJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkRJob) PySparkJob args (https://cloud.google.com/dataproc/docs/reference/rest/v1/PySparkJob) SparkSqlJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/SparkSqlJob) scriptVariables and queryList.queries HiveJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/HiveJob) scriptVariables and queryList.queries PigJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PigJob) scriptVariables and queryList.queries PrestoJob (https://cloud.google.com/dataproc/docs/reference/rest/v1/PrestoJob) scriptVariables and queryList.queries", + "instanceNames": { + "description": "Required. Name of instances to be repaired. These instances must belong to specified node pool.", + "items": { + "type": "string" + }, + "type": "array" + }, + "repairAction": { + "description": "Required. Repair action to take on specified resources of the node pool.", + "enum": [ + "REPAIR_ACTION_UNSPECIFIED", + "REPLACE" + ], + "enumDescriptions": [ + "No action will be taken by default.", + "replace the specified list of nodes." + ], + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two RepairNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" } }, "type": "object" }, - "HadoopJob": { - "description": "A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", - "id": "HadoopJob", + "RepositoryConfig": { + "description": "Configuration for dependency repositories", + "id": "RepositoryConfig", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", - "items": { - "type": "string" - }, - "type": "array" + "pypiRepositoryConfig": { + "$ref": "PyPiRepositoryConfig", + "description": "Optional. Configuration for PyPi repository." + } + }, + "type": "object" + }, + "ReservationAffinity": { + "description": "Reservation Affinity for consuming Zonal reservation.", + "id": "ReservationAffinity", + "properties": { + "consumeReservationType": { + "description": "Optional. Type of reservation to consume", + "enum": [ + "TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], + "enumDescriptions": [ + "", + "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" }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision might occur that causes an incorrect job submission.", - "items": { - "type": "string" - }, - "type": "array" + "key": { + "description": "Optional. Corresponds to the label key of reservation resource.", + "type": "string" }, - "fileUris": { - "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", + "values": { + "description": "Optional. Corresponds to the label values of reservation resource.", "items": { "type": "string" }, "type": "array" + } + }, + "type": "object" + }, + "ResizeNodeGroupRequest": { + "description": "A request to resize a node group.", + "id": "ResizeNodeGroupRequest", + "properties": { + "gracefulDecommissionTimeout": { + "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning) allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.", + "format": "google-duration", + "type": "string" }, - "jarFileUris": { - "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", + "parentOperationId": { + "description": "Optional. operation id of the parent operation sending the resize request", + "type": "string" + }, + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + }, + "size": { + "description": "Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourceInformation": { + "id": "ResourceInformation", + "properties": { + "addresses": { "items": { "type": "string" - }, - "type": "array" - }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." + }, + "type": "array" }, - "mainClass": { - "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", + "name": { "type": "string" + } + }, + "type": "object" + }, + "ResourceProfileInfo": { + "description": "Resource profile that contains information about all the resources required by executors and tasks.", + "id": "ResourceProfileInfo", + "properties": { + "executorResources": { + "additionalProperties": { + "$ref": "ExecutorResourceRequest" + }, + "type": "object" }, - "mainJarFileUri": { - "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", - "type": "string" + "resourceProfileId": { + "format": "int32", + "type": "integer" }, - "properties": { + "taskResources": { "additionalProperties": { - "type": "string" + "$ref": "TaskResourceRequest" }, - "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", "type": "object" } }, "type": "object" }, - "HiveJob": { - "description": "A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", - "id": "HiveJob", + "RuntimeConfig": { + "description": "Runtime configuration for a workload.", + "id": "RuntimeConfig", "properties": { - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" + "autotuningConfig": { + "$ref": "AutotuningConfig", + "description": "Optional. Autotuning configuration of the workload." }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.", - "items": { - "type": "string" - }, - "type": "array" + "cohort": { + "description": "Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.", + "type": "string" + }, + "containerImage": { + "description": "Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.", + "type": "string" }, "properties": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", + "description": "Optional. A mapping of property names to values, which are used to configure workload execution.", "type": "object" }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains Hive queries.", + "repositoryConfig": { + "$ref": "RepositoryConfig", + "description": "Optional. Dependency repository configuration." + }, + "version": { + "description": "Optional. Version of the batch runtime.", "type": "string" + } + }, + "type": "object" + }, + "RuntimeInfo": { + "description": "Runtime information about workload execution.", + "id": "RuntimeInfo", + "properties": { + "approximateUsage": { + "$ref": "UsageMetrics", + "description": "Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).", + "readOnly": true }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." + "currentUsage": { + "$ref": "UsageSnapshot", + "description": "Output only. Snapshot of current workload resource usage.", + "readOnly": true }, - "scriptVariables": { + "diagnosticOutputUri": { + "description": "Output only. A URI pointing to the location of the diagnostics tarball.", + "readOnly": true, + "type": "string" + }, + "endpoints": { "additionalProperties": { "type": "string" }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).", + "description": "Output only. Map of remote access endpoints (such as web interfaces and APIs) to their URIs.", + "readOnly": true, "type": "object" + }, + "outputUri": { + "description": "Output only. A URI pointing to the location of the stdout and stderr of the workload.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "IdentityConfig": { - "description": "Identity related configuration, including service account based secure multi-tenancy user mappings.", - "id": "IdentityConfig", + "SearchSessionSparkApplicationExecutorStageSummaryResponse": { + "description": "List of Executors associated with a Spark Application Stage.", + "id": "SearchSessionSparkApplicationExecutorStageSummaryResponse", "properties": { - "userServiceAccountMapping": { - "additionalProperties": { - "type": "string" + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationExecutorStageSummaryRequest.", + "type": "string" + }, + "sparkApplicationStageExecutors": { + "description": "Details about executors used by the application stage.", + "items": { + "$ref": "ExecutorStageSummary" }, - "description": "Required. Map of user to service account.", - "type": "object" + "type": "array" } }, "type": "object" }, - "InjectCredentialsRequest": { - "description": "A request to inject credentials into a cluster.", - "id": "InjectCredentialsRequest", + "SearchSessionSparkApplicationExecutorsResponse": { + "description": "List of Executors associated with a Spark Application.", + "id": "SearchSessionSparkApplicationExecutorsResponse", "properties": { - "clusterUuid": { - "description": "Required. The cluster UUID.", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationExecutorsRequest.", "type": "string" }, - "credentialsCiphertext": { - "description": "Required. The encrypted credentials being injected in to the cluster.The client is responsible for encrypting the credentials in a way that is supported by the cluster.A wrapped value is used here so that the actual contents of the encrypted credentials are not written to audit logs.", - "type": "string" + "sparkApplicationExecutors": { + "description": "Details about executors used by the application.", + "items": { + "$ref": "ExecutorSummary" + }, + "type": "array" } }, "type": "object" }, - "InstanceFlexibilityPolicy": { - "description": "Instance flexibility Policy allowing a mixture of VM shapes and provisioning models.", - "id": "InstanceFlexibilityPolicy", + "SearchSessionSparkApplicationJobsResponse": { + "description": "A list of Jobs associated with a Spark Application.", + "id": "SearchSessionSparkApplicationJobsResponse", "properties": { - "instanceSelectionList": { - "description": "Optional. List of instance selection options that the group will use when creating new VMs.", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationJobsRequest.", + "type": "string" + }, + "sparkApplicationJobs": { + "description": "Output only. Data corresponding to a spark job.", "items": { - "$ref": "InstanceSelection" + "$ref": "JobData" }, + "readOnly": true, "type": "array" + } + }, + "type": "object" + }, + "SearchSessionSparkApplicationSqlQueriesResponse": { + "description": "List of all queries for a Spark Application.", + "id": "SearchSessionSparkApplicationSqlQueriesResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationSqlQueriesRequest.", + "type": "string" }, - "instanceSelectionResults": { - "description": "Output only. A list of instance selection results in the group.", + "sparkApplicationSqlQueries": { + "description": "Output only. SQL Execution Data", "items": { - "$ref": "InstanceSelectionResult" + "$ref": "SqlExecutionUiData" }, "readOnly": true, "type": "array" @@ -4607,1277 +9686,1124 @@ }, "type": "object" }, - "InstanceGroupAutoscalingPolicyConfig": { - "description": "Configuration for the size bounds of an instance group, including its proportional size to other groups.", - "id": "InstanceGroupAutoscalingPolicyConfig", + "SearchSessionSparkApplicationStageAttemptTasksResponse": { + "description": "List of tasks for a stage of a Spark Application", + "id": "SearchSessionSparkApplicationStageAttemptTasksResponse", "properties": { - "maxInstances": { - "description": "Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set.Primary workers - Bounds: [min_instances, ). Secondary workers - Bounds: [min_instances, ). Default: 0.", - "format": "int32", - "type": "integer" - }, - "minInstances": { - "description": "Optional. Minimum number of instances for this group.Primary workers - Bounds: 2, max_instances. Default: 2. Secondary workers - Bounds: 0, max_instances. Default: 0.", - "format": "int32", - "type": "integer" + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStageAttemptTasksRequest.", + "type": "string" }, - "weight": { - "description": "Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker.The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if max_instances for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created.If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.", - "format": "int32", - "type": "integer" + "sparkApplicationStageAttemptTasks": { + "description": "Output only. Data corresponding to tasks created by spark.", + "items": { + "$ref": "TaskData" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "InstanceGroupConfig": { - "description": "The config settings for Compute Engine resources in an instance group, such as a master or worker group.", - "id": "InstanceGroupConfig", + "SearchSessionSparkApplicationStageAttemptsResponse": { + "description": "A list of Stage Attempts for a Stage of a Spark Application.", + "id": "SearchSessionSparkApplicationStageAttemptsResponse", "properties": { - "accelerators": { - "description": "Optional. The Compute Engine accelerator configuration for these instances.", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStageAttemptsRequest.", + "type": "string" + }, + "sparkApplicationStageAttempts": { + "description": "Output only. Data corresponding to a stage attempts", "items": { - "$ref": "AcceleratorConfig" + "$ref": "StageData" }, + "readOnly": true, "type": "array" - }, - "diskConfig": { - "$ref": "DiskConfig", - "description": "Optional. Disk option config settings." - }, - "imageUri": { - "description": "Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/[image-id] projects/[project_id]/global/images/[image-id] image-idImage family examples. Dataproc will use the most recent image from the family: https://www.googleapis.com/compute/v1/projects/[project_id]/global/images/family/[custom-image-family-name] projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.", + } + }, + "type": "object" + }, + "SearchSessionSparkApplicationStagesResponse": { + "description": "A list of stages associated with a Spark Application.", + "id": "SearchSessionSparkApplicationStagesResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStages.", "type": "string" }, - "instanceFlexibilityPolicy": { - "$ref": "InstanceFlexibilityPolicy", - "description": "Optional. Instance flexibility Policy allowing a mixture of VM shapes and provisioning models." - }, - "instanceNames": { - "description": "Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.", + "sparkApplicationStages": { + "description": "Output only. Data corresponding to a stage.", "items": { - "type": "string" + "$ref": "StageData" }, "readOnly": true, "type": "array" + } + }, + "type": "object" + }, + "SearchSessionSparkApplicationsResponse": { + "description": "A list of summary of Spark Applications", + "id": "SearchSessionSparkApplicationsResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationsRequest.", + "type": "string" }, - "instanceReferences": { - "description": "Output only. List of references to Compute Engine instances.", + "sparkApplications": { + "description": "Output only. High level information corresponding to an application.", "items": { - "$ref": "InstanceReference" + "$ref": "SparkApplication" }, "readOnly": true, "type": "array" - }, - "isPreemptible": { - "description": "Output only. Specifies that this instance group contains preemptible instances.", - "readOnly": true, - "type": "boolean" - }, - "machineTypeUri": { - "description": "Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 projects/[project_id]/zones/[zone]/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.", - "type": "string" - }, - "managedGroupConfig": { - "$ref": "ManagedGroupConfig", - "description": "Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.", - "readOnly": true - }, - "minCpuPlatform": { - "description": "Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).", + } + }, + "type": "object" + }, + "SearchSparkApplicationExecutorStageSummaryResponse": { + "description": "List of Executors associated with a Spark Application Stage.", + "id": "SearchSparkApplicationExecutorStageSummaryResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationExecutorsListRequest.", "type": "string" }, - "minNumInstances": { - "description": "Optional. The minimum number of primary worker instances to create. If min_num_instances is set, cluster creation will succeed if the number of primary workers created is at least equal to the min_num_instances number.Example: Cluster creation request with num_instances = 5 and min_num_instances = 3: If 4 VMs are created and 1 instance fails, the failed VM is deleted. The cluster is resized to 4 instances and placed in a RUNNING state. If 2 instances are created and 3 instances fail, the cluster in placed in an ERROR state. The failed VMs are not deleted.", - "format": "int32", - "type": "integer" - }, - "numInstances": { - "description": "Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1.", - "format": "int32", - "type": "integer" - }, - "preemptibility": { - "description": "Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.", - "enum": [ - "PREEMPTIBILITY_UNSPECIFIED", - "NON_PREEMPTIBLE", - "PREEMPTIBLE", - "SPOT" - ], - "enumDescriptions": [ - "Preemptibility is unspecified, the system will choose the appropriate setting for each instance group.", - "Instances are non-preemptible.This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.", - "Instances are preemptible (https://cloud.google.com/compute/docs/instances/preemptible).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups.", - "Instances are Spot VMs (https://cloud.google.com/compute/docs/instances/spot).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups. Spot VMs are the latest version of preemptible VMs (https://cloud.google.com/compute/docs/instances/preemptible), and provide additional features." - ], + "sparkApplicationStageExecutors": { + "description": "Details about executors used by the application stage.", + "items": { + "$ref": "ExecutorStageSummary" + }, + "type": "array" + } + }, + "type": "object" + }, + "SearchSparkApplicationExecutorsResponse": { + "description": "List of Executors associated with a Spark Application.", + "id": "SearchSparkApplicationExecutorsResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationExecutorsListRequest.", "type": "string" }, - "startupConfig": { - "$ref": "StartupConfig", - "description": "Optional. Configuration to handle the startup of instances during cluster create and update process." + "sparkApplicationExecutors": { + "description": "Details about executors used by the application.", + "items": { + "$ref": "ExecutorSummary" + }, + "type": "array" } }, "type": "object" }, - "InstanceReference": { - "description": "A reference to a Compute Engine instance.", - "id": "InstanceReference", + "SearchSparkApplicationJobsResponse": { + "description": "A list of Jobs associated with a Spark Application.", + "id": "SearchSparkApplicationJobsResponse", "properties": { - "instanceId": { - "description": "The unique identifier of the Compute Engine instance.", - "type": "string" - }, - "instanceName": { - "description": "The user-friendly name of the Compute Engine instance.", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationJobsRequest.", "type": "string" }, - "publicEciesKey": { - "description": "The public ECIES key used for sharing data with this instance.", + "sparkApplicationJobs": { + "description": "Output only. Data corresponding to a spark job.", + "items": { + "$ref": "JobData" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "SearchSparkApplicationSqlQueriesResponse": { + "description": "List of all queries for a Spark Application.", + "id": "SearchSparkApplicationSqlQueriesResponse", + "properties": { + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationSqlQueriesRequest.", "type": "string" }, - "publicKey": { - "description": "The public RSA key used for sharing data with this instance.", - "type": "string" + "sparkApplicationSqlQueries": { + "description": "Output only. SQL Execution Data", + "items": { + "$ref": "SqlExecutionUiData" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "InstanceSelection": { - "description": "Defines machines types and a rank to which the machines types belong.", - "id": "InstanceSelection", + "SearchSparkApplicationStageAttemptTasksResponse": { + "description": "List of tasks for a stage of a Spark Application", + "id": "SearchSparkApplicationStageAttemptTasksResponse", "properties": { - "machineTypes": { - "description": "Optional. Full machine-type names, e.g. \"n1-standard-16\".", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListSparkApplicationStageAttemptTasksRequest.", + "type": "string" + }, + "sparkApplicationStageAttemptTasks": { + "description": "Output only. Data corresponding to tasks created by spark.", "items": { - "type": "string" + "$ref": "TaskData" }, + "readOnly": true, "type": "array" - }, - "rank": { - "description": "Optional. Preference of this instance selection. Lower number means higher preference. Dataproc will first try to create a VM based on the machine-type with priority rank and fallback to next rank based on availability. Machine types and instance selections with the same priority have the same preference.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "InstanceSelectionResult": { - "description": "Defines a mapping from machine types to the number of VMs that are created with each machine type.", - "id": "InstanceSelectionResult", + "SearchSparkApplicationStageAttemptsResponse": { + "description": "A list of Stage Attempts for a Stage of a Spark Application.", + "id": "SearchSparkApplicationStageAttemptsResponse", "properties": { - "machineType": { - "description": "Output only. Full machine-type names, e.g. \"n1-standard-16\".", - "readOnly": true, + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListSparkApplicationStageAttemptsRequest.", "type": "string" }, - "vmCount": { - "description": "Output only. Number of VM provisioned with the machine_type.", - "format": "int32", + "sparkApplicationStageAttempts": { + "description": "Output only. Data corresponding to a stage attempts", + "items": { + "$ref": "StageData" + }, "readOnly": true, - "type": "integer" + "type": "array" } }, "type": "object" }, - "InstantiateWorkflowTemplateRequest": { - "description": "A request to instantiate a workflow template.", - "id": "InstantiateWorkflowTemplateRequest", + "SearchSparkApplicationStagesResponse": { + "description": "A list of stages associated with a Spark Application.", + "id": "SearchSparkApplicationStagesResponse", "properties": { - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.", - "type": "object" - }, - "requestId": { - "description": "Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationStages.", "type": "string" }, - "version": { - "description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.", - "format": "int32", - "type": "integer" + "sparkApplicationStages": { + "description": "Output only. Data corresponding to a stage.", + "items": { + "$ref": "StageData" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "Interval": { - "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", - "id": "Interval", + "SearchSparkApplicationsResponse": { + "description": "A list of summary of Spark Applications", + "id": "SearchSparkApplicationsResponse", "properties": { - "endTime": { - "description": "Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", + "nextPageToken": { + "description": "This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationsRequest.", "type": "string" }, - "startTime": { - "description": "Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "type": "string" + "sparkApplications": { + "description": "Output only. High level information corresponding to an application.", + "items": { + "$ref": "SparkApplication" + }, + "readOnly": true, + "type": "array" } }, "type": "object" }, - "Job": { - "description": "A Dataproc job resource.", - "id": "Job", + "SecurityConfig": { + "description": "Security related configuration, including encryption, Kerberos, etc.", + "id": "SecurityConfig", "properties": { - "done": { - "description": "Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled.", - "readOnly": true, - "type": "boolean" + "identityConfig": { + "$ref": "IdentityConfig", + "description": "Optional. Identity related configuration, including service account based secure multi-tenancy user mappings." }, - "driverControlFilesUri": { - "description": "Output only. If present, the location of miscellaneous control files which can be used as part of job setup and handling. If not present, control files might be placed in the same location as driver_output_uri.", + "kerberosConfig": { + "$ref": "KerberosConfig", + "description": "Optional. Kerberos related configuration." + } + }, + "type": "object" + }, + "Session": { + "description": "A representation of a session.", + "id": "Session", + "properties": { + "createTime": { + "description": "Output only. The time when the session was created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "driverOutputResourceUri": { - "description": "Output only. A URI pointing to the location of the stdout of the job's driver program.", + "creator": { + "description": "Output only. The email address of the user who created the session.", "readOnly": true, "type": "string" }, - "driverSchedulingConfig": { - "$ref": "DriverSchedulingConfig", - "description": "Optional. Driver scheduling configuration." - }, - "flinkJob": { - "$ref": "FlinkJob", - "description": "Optional. Job is a Flink job." - }, - "hadoopJob": { - "$ref": "HadoopJob", - "description": "Optional. Job is a Hadoop job." - }, - "hiveJob": { - "$ref": "HiveJob", - "description": "Optional. Job is a Hive job." + "environmentConfig": { + "$ref": "EnvironmentConfig", + "description": "Optional. Environment configuration for the session execution." }, - "jobUuid": { - "description": "Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that might be reused over time.", - "readOnly": true, - "type": "string" + "jupyterSession": { + "$ref": "JupyterConfig", + "description": "Optional. Jupyter session config." }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", + "description": "Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.", "type": "object" }, - "pigJob": { - "$ref": "PigJob", - "description": "Optional. Job is a Pig job." - }, - "placement": { - "$ref": "JobPlacement", - "description": "Required. Job information, including how, when, and where to run the job." - }, - "prestoJob": { - "$ref": "PrestoJob", - "description": "Optional. Job is a Presto job." - }, - "pysparkJob": { - "$ref": "PySparkJob", - "description": "Optional. Job is a PySpark job." - }, - "reference": { - "$ref": "JobReference", - "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a job_id." - }, - "scheduling": { - "$ref": "JobScheduling", - "description": "Optional. Job scheduling configuration." + "name": { + "description": "Required. The resource name of the session.", + "type": "string" }, - "sparkJob": { - "$ref": "SparkJob", - "description": "Optional. Job is a Spark job." + "runtimeConfig": { + "$ref": "RuntimeConfig", + "description": "Optional. Runtime configuration for the session execution." }, - "sparkRJob": { - "$ref": "SparkRJob", - "description": "Optional. Job is a SparkR job." + "runtimeInfo": { + "$ref": "RuntimeInfo", + "description": "Output only. Runtime information about session execution.", + "readOnly": true }, - "sparkSqlJob": { - "$ref": "SparkSqlJob", - "description": "Optional. Job is a SparkSql job." + "sessionTemplate": { + "description": "Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.", + "type": "string" }, - "status": { - "$ref": "JobStatus", - "description": "Output only. The job status. Additional application-specific status information might be contained in the type_job and yarn_applications fields.", - "readOnly": true + "sparkConnectSession": { + "$ref": "SparkConnectConfig", + "description": "Optional. Spark connect session config." }, - "statusHistory": { - "description": "Output only. The previous job status.", - "items": { - "$ref": "JobStatus" - }, + "state": { + "description": "Output only. A state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "TERMINATING", + "TERMINATED", + "FAILED" + ], + "enumDescriptions": [ + "The session state is unknown.", + "The session is created prior to running.", + "The session is running.", + "The session is terminating.", + "The session is terminated successfully.", + "The session is no longer running due to an error." + ], "readOnly": true, - "type": "array" - }, - "trinoJob": { - "$ref": "TrinoJob", - "description": "Optional. Job is a Trino job." + "type": "string" }, - "yarnApplications": { - "description": "Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It might be changed before final release.", + "stateHistory": { + "description": "Output only. Historical state information for the session.", "items": { - "$ref": "YarnApplication" + "$ref": "SessionStateHistory" }, "readOnly": true, - "type": "array" - } - }, - "type": "object" - }, - "JobMetadata": { - "description": "Job Operation metadata.", - "id": "JobMetadata", - "properties": { - "jobId": { - "description": "Output only. The job id.", - "readOnly": true, - "type": "string" + "type": "array" }, - "operationType": { - "description": "Output only. Operation type.", + "stateMessage": { + "description": "Output only. Session state details, such as the failure description if the state is FAILED.", "readOnly": true, "type": "string" }, - "startTime": { - "description": "Output only. Job submission time.", + "stateTime": { + "description": "Output only. The time when the session entered the current state.", "format": "google-datetime", "readOnly": true, "type": "string" }, - "status": { - "$ref": "JobStatus", - "description": "Output only. Most recent job status.", - "readOnly": true - } - }, - "type": "object" - }, - "JobPlacement": { - "description": "Dataproc job config.", - "id": "JobPlacement", - "properties": { - "clusterLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Cluster labels to identify a cluster where the job will be submitted.", - "type": "object" - }, - "clusterName": { - "description": "Required. The name of the cluster where the job will be submitted.", + "user": { + "description": "Optional. The email address of the user who owns the session.", "type": "string" }, - "clusterUuid": { - "description": "Output only. A cluster UUID generated by the Dataproc service when the job is submitted.", + "uuid": { + "description": "Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.", "readOnly": true, "type": "string" } }, "type": "object" }, - "JobReference": { - "description": "Encapsulates the full scoping used to reference a job.", - "id": "JobReference", + "SessionOperationMetadata": { + "description": "Metadata describing the Session operation.", + "id": "SessionOperationMetadata", "properties": { - "jobId": { - "description": "Optional. The job ID, which must be unique within the project.The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.If not specified by the caller, the job ID will be provided by the server.", + "createTime": { + "description": "The time when the operation was created.", + "format": "google-datetime", "type": "string" }, - "projectId": { - "description": "Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID.", + "description": { + "description": "Short description of the operation.", "type": "string" - } - }, - "type": "object" - }, - "JobScheduling": { - "description": "Job scheduling options.", - "id": "JobScheduling", - "properties": { - "maxFailuresPerHour": { - "description": "Optional. Maximum number of times per hour a driver can be restarted as a result of driver exiting with non-zero code before job is reported failed.A job might be reported as thrashing if the driver exits with a non-zero code four times within a 10-minute window.Maximum value is 10.Note: This restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template).", - "format": "int32", - "type": "integer" }, - "maxFailuresTotal": { - "description": "Optional. Maximum total number of times a driver can be restarted as a result of the driver exiting with a non-zero code. After the maximum number is reached, the job will be reported as failed.Maximum value is 240.Note: Currently, this restartable job option is not supported in Dataproc workflow templates (https://cloud.google.com/dataproc/docs/concepts/workflows/using-workflows#adding_jobs_to_a_template).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "JobStatus": { - "description": "Dataproc job status.", - "id": "JobStatus", - "properties": { - "details": { - "description": "Optional. Output only. Job state details, such as an error description if the state is ERROR.", - "readOnly": true, + "doneTime": { + "description": "The time when the operation was finished.", + "format": "google-datetime", "type": "string" }, - "state": { - "description": "Output only. A state message specifying the overall job state.", + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with the operation.", + "type": "object" + }, + "operationType": { + "description": "The operation type.", "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "SETUP_DONE", - "RUNNING", - "CANCEL_PENDING", - "CANCEL_STARTED", - "CANCELLED", - "DONE", - "ERROR", - "ATTEMPT_FAILURE" + "SESSION_OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "TERMINATE", + "DELETE" ], "enumDescriptions": [ - "The job state is unknown.", - "The job is pending; it has been submitted, but is not yet running.", - "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.", - "The job is running on the cluster.", - "A CancelJob request has been received, but is pending.", - "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.", - "The job cancellation was successful.", - "The job has completed successfully.", - "The job has completed, but encountered an error.", - "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only." + "Session operation type is unknown.", + "Create Session operation type.", + "Terminate Session operation type.", + "Delete Session operation type." ], - "readOnly": true, "type": "string" }, - "stateStartTime": { - "description": "Output only. The time when this state was entered.", - "format": "google-datetime", - "readOnly": true, + "session": { + "description": "Name of the session for the operation.", "type": "string" }, - "substate": { - "description": "Output only. Additional state information, which includes status reported by the agent.", - "enum": [ - "UNSPECIFIED", - "SUBMITTED", - "QUEUED", - "STALE_STATUS" - ], - "enumDescriptions": [ - "The job substate is unknown.", - "The Job is submitted to the agent.Applies to RUNNING state.", - "The Job has been received and is awaiting execution (it might be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.", - "The agent-reported status is out of date, which can be caused by a loss of communication between the agent and Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state." - ], - "readOnly": true, + "sessionUuid": { + "description": "Session UUID for the operation.", "type": "string" + }, + "warnings": { + "description": "Warnings encountered during operation execution.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "JupyterConfig": { - "description": "Jupyter configuration for an interactive session.", - "id": "JupyterConfig", + "SessionStateHistory": { + "description": "Historical state information.", + "id": "SessionStateHistory", "properties": { - "displayName": { - "description": "Optional. Display name, shown in the Jupyter kernelspec card.", - "type": "string" - }, - "kernel": { - "description": "Optional. Kernel", + "state": { + "description": "Output only. The state of the session at this point in the session history.", "enum": [ - "KERNEL_UNSPECIFIED", - "PYTHON", - "SCALA" + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "TERMINATING", + "TERMINATED", + "FAILED" ], "enumDescriptions": [ - "The kernel is unknown.", - "Python kernel.", - "Scala kernel." + "The session state is unknown.", + "The session is created prior to running.", + "The session is running.", + "The session is terminating.", + "The session is terminated successfully.", + "The session is no longer running due to an error." ], - "type": "string" - } - }, - "type": "object" - }, - "KerberosConfig": { - "description": "Specifies Kerberos related configuration.", - "id": "KerberosConfig", - "properties": { - "crossRealmTrustAdminServer": { - "description": "Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.", - "type": "string" - }, - "crossRealmTrustKdc": { - "description": "Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.", - "type": "string" - }, - "crossRealmTrustRealm": { - "description": "Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.", - "type": "string" - }, - "crossRealmTrustSharedPasswordUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.", - "type": "string" - }, - "enableKerberos": { - "description": "Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.", - "type": "boolean" - }, - "kdcDbKeyUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.", - "type": "string" - }, - "keyPasswordUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.", - "type": "string" - }, - "keystorePasswordUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.", - "type": "string" - }, - "keystoreUri": { - "description": "Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.", - "type": "string" - }, - "kmsKeyUri": { - "description": "Optional. The URI of the KMS key used to encrypt sensitive files.", - "type": "string" - }, - "realm": { - "description": "Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.", - "type": "string" - }, - "rootPrincipalPasswordUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password.", + "readOnly": true, "type": "string" }, - "tgtLifetimeHours": { - "description": "Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.", - "format": "int32", - "type": "integer" - }, - "truststorePasswordUri": { - "description": "Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.", + "stateMessage": { + "description": "Output only. Details about the state at this point in the session history.", + "readOnly": true, "type": "string" }, - "truststoreUri": { - "description": "Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.", + "stateStartTime": { + "description": "Output only. The time when the session entered the historical state.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "KubernetesClusterConfig": { - "description": "The configuration for running the Dataproc cluster on Kubernetes.", - "id": "KubernetesClusterConfig", + "SessionTemplate": { + "description": "A representation of a session template.", + "id": "SessionTemplate", "properties": { - "gkeClusterConfig": { - "$ref": "GkeClusterConfig", - "description": "Required. The configuration for running the Dataproc cluster on GKE." + "createTime": { + "description": "Output only. The time when the template was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "kubernetesNamespace": { - "description": "Optional. A namespace within the Kubernetes cluster to deploy into. If this namespace does not exist, it is created. If it exists, Dataproc verifies that another Dataproc VirtualCluster is not installed into it. If not specified, the name of the Dataproc Cluster is used.", + "creator": { + "description": "Output only. The email address of the user who created the template.", + "readOnly": true, "type": "string" }, - "kubernetesSoftwareConfig": { - "$ref": "KubernetesSoftwareConfig", - "description": "Optional. The software configuration for this Dataproc cluster running on Kubernetes." - } - }, - "type": "object" - }, - "KubernetesSoftwareConfig": { - "description": "The software configuration for this Dataproc cluster running on Kubernetes.", - "id": "KubernetesSoftwareConfig", - "properties": { - "componentVersion": { - "additionalProperties": { - "type": "string" - }, - "description": "The components that should be installed in this Dataproc cluster. The key must be a string from the KubernetesComponent enumeration. The value is the version of the software to be installed. At least one entry must be specified.", - "type": "object" + "description": { + "description": "Optional. Brief description of the template.", + "type": "string" }, - "properties": { + "environmentConfig": { + "$ref": "EnvironmentConfig", + "description": "Optional. Environment configuration for session execution." + }, + "jupyterSession": { + "$ref": "JupyterConfig", + "description": "Optional. Jupyter session config." + }, + "labels": { "additionalProperties": { "type": "string" }, - "description": "The properties to set on daemon config files.Property keys are specified in prefix:property format, for example spark:spark.kubernetes.container.image. The following are supported prefixes and their mappings: spark: spark-defaults.confFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).", + "description": "Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.", "type": "object" - } - }, - "type": "object" - }, - "LifecycleConfig": { - "description": "Specifies the cluster auto-delete schedule configuration.", - "id": "LifecycleConfig", - "properties": { - "autoDeleteTime": { - "description": "Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", - "format": "google-datetime", - "type": "string" }, - "autoDeleteTtl": { - "description": "Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", - "format": "google-duration", + "name": { + "description": "Required. The resource name of the session template.", "type": "string" }, - "idleDeleteTtl": { - "description": "Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).", - "format": "google-duration", - "type": "string" + "runtimeConfig": { + "$ref": "RuntimeConfig", + "description": "Optional. Runtime configuration for session execution." }, - "idleStartTime": { - "description": "Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).", + "sparkConnectSession": { + "$ref": "SparkConnectConfig", + "description": "Optional. Spark connect session config." + }, + "updateTime": { + "description": "Output only. The time the template was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" + }, + "uuid": { + "description": "Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "ListAutoscalingPoliciesResponse": { - "description": "A response to a request to list autoscaling policies in a project.", - "id": "ListAutoscalingPoliciesResponse", + "SetIamPolicyRequest": { + "description": "Request message for SetIamPolicy method.", + "id": "SetIamPolicyRequest", "properties": { - "nextPageToken": { - "description": "Output only. This token is included in the response if there are more results to fetch.", - "readOnly": true, - "type": "string" - }, - "policies": { - "description": "Output only. Autoscaling policies list.", - "items": { - "$ref": "AutoscalingPolicy" - }, - "readOnly": true, - "type": "array" + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." } }, "type": "object" }, - "ListBatchesResponse": { - "description": "A list of batch workloads.", - "id": "ListBatchesResponse", + "ShieldedInstanceConfig": { + "description": "Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).", + "id": "ShieldedInstanceConfig", "properties": { - "batches": { - "description": "Output only. The batches from the specified collection.", - "items": { - "$ref": "Batch" - }, - "readOnly": true, - "type": "array" + "enableIntegrityMonitoring": { + "description": "Optional. Defines whether instances have integrity monitoring enabled.", + "type": "boolean" }, - "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" + "enableSecureBoot": { + "description": "Optional. Defines whether instances have Secure Boot enabled.", + "type": "boolean" }, - "unreachable": { - "description": "Output only. List of Batches that could not be included in the response. Attempting to get one of these resources may indicate why it was not included in the list response.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "enableVtpm": { + "description": "Optional. Defines whether instances have the vTPM enabled.", + "type": "boolean" } }, "type": "object" }, - "ListClustersResponse": { - "description": "The list of all clusters in a project.", - "id": "ListClustersResponse", + "ShufflePushReadMetrics": { + "id": "ShufflePushReadMetrics", "properties": { - "clusters": { - "description": "Output only. The clusters in the project.", - "items": { - "$ref": "Cluster" - }, - "readOnly": true, - "type": "array" + "corruptMergedBlockChunks": { + "format": "int64", + "type": "string" }, - "nextPageToken": { - "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.", - "readOnly": true, + "localMergedBlocksFetched": { + "format": "int64", + "type": "string" + }, + "localMergedBytesRead": { + "format": "int64", + "type": "string" + }, + "localMergedChunksFetched": { + "format": "int64", + "type": "string" + }, + "mergedFetchFallbackCount": { + "format": "int64", + "type": "string" + }, + "remoteMergedBlocksFetched": { + "format": "int64", + "type": "string" + }, + "remoteMergedBytesRead": { + "format": "int64", + "type": "string" + }, + "remoteMergedChunksFetched": { + "format": "int64", + "type": "string" + }, + "remoteMergedReqsDuration": { + "format": "int64", "type": "string" } }, "type": "object" }, - "ListJobsResponse": { - "description": "A list of jobs in a project.", - "id": "ListJobsResponse", + "ShufflePushReadQuantileMetrics": { + "id": "ShufflePushReadQuantileMetrics", "properties": { - "jobs": { - "description": "Output only. Jobs list.", - "items": { - "$ref": "Job" - }, - "readOnly": true, - "type": "array" + "corruptMergedBlockChunks": { + "$ref": "Quantiles" }, - "nextPageToken": { - "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListJobsRequest.", - "type": "string" + "localMergedBlocksFetched": { + "$ref": "Quantiles" }, - "unreachable": { - "description": "Output only. List of jobs with kms_key-encrypted parameters that could not be decrypted. A response to a jobs.get request may indicate the reason for the decryption failure for a specific job.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "localMergedBytesRead": { + "$ref": "Quantiles" + }, + "localMergedChunksFetched": { + "$ref": "Quantiles" + }, + "mergedFetchFallbackCount": { + "$ref": "Quantiles" + }, + "remoteMergedBlocksFetched": { + "$ref": "Quantiles" + }, + "remoteMergedBytesRead": { + "$ref": "Quantiles" + }, + "remoteMergedChunksFetched": { + "$ref": "Quantiles" + }, + "remoteMergedReqsDuration": { + "$ref": "Quantiles" } }, "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "id": "ListOperationsResponse", + "ShuffleReadMetrics": { + "description": "Shuffle data read by the task.", + "id": "ShuffleReadMetrics", "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", + "fetchWaitTimeMillis": { + "format": "int64", "type": "string" }, - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "items": { - "$ref": "Operation" - }, - "type": "array" + "localBlocksFetched": { + "format": "int64", + "type": "string" + }, + "localBytesRead": { + "format": "int64", + "type": "string" + }, + "recordsRead": { + "format": "int64", + "type": "string" + }, + "remoteBlocksFetched": { + "format": "int64", + "type": "string" + }, + "remoteBytesRead": { + "format": "int64", + "type": "string" + }, + "remoteBytesReadToDisk": { + "format": "int64", + "type": "string" + }, + "remoteReqsDuration": { + "format": "int64", + "type": "string" + }, + "shufflePushReadMetrics": { + "$ref": "ShufflePushReadMetrics" } }, "type": "object" }, - "ListSessionTemplatesResponse": { - "description": "A list of session templates.", - "id": "ListSessionTemplatesResponse", + "ShuffleReadQuantileMetrics": { + "id": "ShuffleReadQuantileMetrics", "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" + "fetchWaitTimeMillis": { + "$ref": "Quantiles" }, - "sessionTemplates": { - "description": "Output only. Session template list", - "items": { - "$ref": "SessionTemplate" - }, - "readOnly": true, - "type": "array" + "localBlocksFetched": { + "$ref": "Quantiles" + }, + "readBytes": { + "$ref": "Quantiles" + }, + "readRecords": { + "$ref": "Quantiles" + }, + "remoteBlocksFetched": { + "$ref": "Quantiles" + }, + "remoteBytesRead": { + "$ref": "Quantiles" + }, + "remoteBytesReadToDisk": { + "$ref": "Quantiles" + }, + "remoteReqsDuration": { + "$ref": "Quantiles" + }, + "shufflePushReadMetrics": { + "$ref": "ShufflePushReadQuantileMetrics" + }, + "totalBlocksFetched": { + "$ref": "Quantiles" } }, "type": "object" }, - "ListSessionsResponse": { - "description": "A list of interactive sessions.", - "id": "ListSessionsResponse", + "ShuffleWriteMetrics": { + "description": "Shuffle data written by task.", + "id": "ShuffleWriteMetrics", "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.", + "bytesWritten": { + "format": "int64", "type": "string" }, - "sessions": { - "description": "Output only. The sessions from the specified collection.", - "items": { - "$ref": "Session" - }, - "readOnly": true, - "type": "array" + "recordsWritten": { + "format": "int64", + "type": "string" + }, + "writeTimeNanos": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "ListWorkflowTemplatesResponse": { - "description": "A response to a request to list workflow templates in a project.", - "id": "ListWorkflowTemplatesResponse", + "ShuffleWriteQuantileMetrics": { + "id": "ShuffleWriteQuantileMetrics", "properties": { - "nextPageToken": { - "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListWorkflowTemplatesRequest.", - "readOnly": true, - "type": "string" + "writeBytes": { + "$ref": "Quantiles" }, - "templates": { - "description": "Output only. WorkflowTemplates list.", - "items": { - "$ref": "WorkflowTemplate" - }, - "readOnly": true, - "type": "array" + "writeRecords": { + "$ref": "Quantiles" }, - "unreachable": { - "description": "Output only. List of workflow templates that could not be included in the response. Attempting to get one of these resources may indicate why it was not included in the list response.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "writeTimeNanos": { + "$ref": "Quantiles" } }, "type": "object" }, - "LoggingConfig": { - "description": "The runtime logging config of the job.", - "id": "LoggingConfig", + "SinkProgress": { + "id": "SinkProgress", "properties": { - "driverLogLevels": { + "description": { + "type": "string" + }, + "metrics": { "additionalProperties": { - "enum": [ - "LEVEL_UNSPECIFIED", - "ALL", - "TRACE", - "DEBUG", - "INFO", - "WARN", - "ERROR", - "FATAL", - "OFF" - ], - "enumDescriptions": [ - "Level is unspecified. Use default level for log4j.", - "Use ALL level for log4j.", - "Use TRACE level for log4j.", - "Use DEBUG level for log4j.", - "Use INFO level for log4j.", - "Use WARN level for log4j.", - "Use ERROR level for log4j.", - "Use FATAL level for log4j.", - "Turn off log4j." - ], "type": "string" }, - "description": "The per-package log levels for the driver. This can include \"root\" package name to configure rootLogger. Examples: - 'com.google = FATAL' - 'root = INFO' - 'org.apache = DEBUG'", "type": "object" + }, + "numOutputRows": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "ManagedCluster": { - "description": "Cluster that is managed by the workflow.", - "id": "ManagedCluster", + "SoftwareConfig": { + "description": "Specifies the selection and config of software inside the cluster.", + "id": "SoftwareConfig", "properties": { - "clusterName": { - "description": "Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.", + "imageVersion": { + "description": "Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported-dataproc-image-versions), such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.", "type": "string" }, - "config": { - "$ref": "ClusterConfig", - "description": "Required. The cluster configuration." + "optionalComponents": { + "description": "Optional. The set of components to activate on the cluster.", + "items": { + "enum": [ + "COMPONENT_UNSPECIFIED", + "ANACONDA", + "DOCKER", + "DRUID", + "FLINK", + "HBASE", + "HIVE_WEBHCAT", + "HUDI", + "JUPYTER", + "PRESTO", + "TRINO", + "RANGER", + "SOLR", + "ZEPPELIN", + "ZOOKEEPER" + ], + "enumDescriptions": [ + "Unspecified component. Specifying this will cause Cluster creation to fail.", + "The Anaconda component is no longer supported or applicable to supported Dataproc on Compute Engine image versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-version-clusters#supported-dataproc-image-versions). It cannot be activated on clusters created with supported Dataproc on Compute Engine image versions.", + "Docker", + "The Druid query engine. (alpha)", + "Flink", + "HBase. (beta)", + "The Hive Web HCatalog (the REST service for accessing HCatalog).", + "Hudi.", + "The Jupyter Notebook.", + "The Presto query engine.", + "The Trino query engine.", + "The Ranger service.", + "The Solr service.", + "The Zeppelin notebook.", + "The Zookeeper service." + ], + "type": "string" + }, + "type": "array" }, - "labels": { + "properties": { "additionalProperties": { "type": "string" }, - "description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.", + "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).", "type": "object" } }, "type": "object" }, - "ManagedGroupConfig": { - "description": "Specifies the resources used to actively manage an instance group.", - "id": "ManagedGroupConfig", + "SourceProgress": { + "id": "SourceProgress", "properties": { - "instanceGroupManagerName": { - "description": "Output only. The name of the Instance Group Manager for this group.", - "readOnly": true, + "description": { "type": "string" }, - "instanceGroupManagerUri": { - "description": "Output only. The partial URI to the instance group manager for this group. E.g. projects/my-project/regions/us-central1/instanceGroupManagers/my-igm.", - "readOnly": true, + "endOffset": { "type": "string" }, - "instanceTemplateName": { - "description": "Output only. The name of the Instance Template used for the Managed Instance Group.", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "MetastoreConfig": { - "description": "Specifies a Metastore configuration.", - "id": "MetastoreConfig", - "properties": { - "dataprocMetastoreService": { - "description": "Required. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[dataproc_region]/services/[service-name]", + "inputRowsPerSecond": { + "format": "double", + "type": "number" + }, + "latestOffset": { "type": "string" - } - }, - "type": "object" - }, - "Metric": { - "description": "A Dataproc custom metric.", - "id": "Metric", - "properties": { - "metricOverrides": { - "description": "Optional. Specify one or more Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) to collect for the metric course (for the SPARK metric source (any Spark metric (https://spark.apache.org/docs/latest/monitoring.html#metrics) can be specified).Provide metrics in the following format: METRIC_SOURCE: INSTANCE:GROUP:METRIC Use camelcase as appropriate.Examples: yarn:ResourceManager:QueueMetrics:AppsCompleted spark:driver:DAGScheduler:job.allJobs sparkHistoryServer:JVM:Memory:NonHeapMemoryUsage.committed hiveserver2:JVM:Memory:NonHeapMemoryUsage.used Notes: Only the specified overridden metrics are collected for the metric source. For example, if one or more spark:executive metrics are listed as metric overrides, other SPARK metrics are not collected. The collection of the metrics for other enabled custom metric sources is unaffected. For example, if both SPARK andd YARN metric sources are enabled, and overrides are provided for Spark metrics only, all YARN metrics are collected.", - "items": { + }, + "metrics": { + "additionalProperties": { "type": "string" }, - "type": "array" + "type": "object" }, - "metricSource": { - "description": "Required. A standard set of metrics is collected unless metricOverrides are specified for the metric source (see Custom metrics (https://cloud.google.com/dataproc/docs/guides/dataproc-metrics#custom_metrics) for more information).", - "enum": [ - "METRIC_SOURCE_UNSPECIFIED", - "MONITORING_AGENT_DEFAULTS", - "HDFS", - "SPARK", - "YARN", - "SPARK_HISTORY_SERVER", - "HIVESERVER2", - "HIVEMETASTORE", - "FLINK" - ], - "enumDescriptions": [ - "Required unspecified metric source.", - "Monitoring agent metrics. If this source is enabled, Dataproc enables the monitoring agent in Compute Engine, and collects monitoring agent metrics, which are published with an agent.googleapis.com prefix.", - "HDFS metric source.", - "Spark metric source.", - "YARN metric source.", - "Spark History Server metric source.", - "Hiveserver2 metric source.", - "hivemetastore metric source", - "flink metric source" - ], + "numInputRows": { + "format": "int64", + "type": "string" + }, + "processedRowsPerSecond": { + "format": "double", + "type": "number" + }, + "startOffset": { "type": "string" } }, "type": "object" }, - "NamespacedGkeDeploymentTarget": { - "deprecated": true, - "description": "Deprecated. Used only for the deprecated beta. A full, namespace-isolated deployment target for an existing GKE cluster.", - "id": "NamespacedGkeDeploymentTarget", + "SparkApplication": { + "description": "A summary of Spark Application", + "id": "SparkApplication", "properties": { - "clusterNamespace": { - "description": "Optional. A namespace within the GKE cluster to deploy into.", - "type": "string" + "application": { + "$ref": "ApplicationInfo", + "description": "Output only. High level information corresponding to an application.", + "readOnly": true }, - "targetGkeCluster": { - "description": "Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'", + "name": { + "description": "Identifier. Name of the spark application", "type": "string" } }, "type": "object" }, - "NodeGroup": { - "description": "Dataproc Node Group. The Dataproc NodeGroup resource is not related to the Dataproc NodeGroupAffinity resource.", - "id": "NodeGroup", + "SparkBatch": { + "description": "A configuration for running an Apache Spark (https://spark.apache.org/) batch workload.", + "id": "SparkBatch", "properties": { - "labels": { - "additionalProperties": { + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { "type": "string" }, - "description": "Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn.", - "type": "object" - }, - "name": { - "description": "The Node group resource name (https://aip.dev/122).", - "type": "string" + "type": "array" }, - "nodeGroupConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The node group instance group configuration." + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", + "items": { + "type": "string" + }, + "type": "array" }, - "roles": { - "description": "Required. Node group roles.", + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", + "items": { + "type": "string" + }, + "type": "array" + }, + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.", "items": { - "enum": [ - "ROLE_UNSPECIFIED", - "DRIVER" - ], - "enumDescriptions": [ - "Required unspecified role.", - "Job drivers run on the node pool." - ], "type": "string" }, "type": "array" + }, + "mainClass": { + "description": "Optional. The name of the driver main class. The jar file that contains the class must be in the classpath or specified in jar_file_uris.", + "type": "string" + }, + "mainJarFileUri": { + "description": "Optional. The HCFS URI of the jar file that contains the main class.", + "type": "string" } }, "type": "object" }, - "NodeGroupAffinity": { - "description": "Node Group Affinity for clusters using sole-tenant node groups. The Dataproc NodeGroupAffinity resource is not related to the Dataproc NodeGroup resource.", - "id": "NodeGroupAffinity", + "SparkConnectConfig": { + "description": "Spark connect configuration for an interactive session.", + "id": "SparkConnectConfig", + "properties": {}, + "type": "object" + }, + "SparkHistoryServerConfig": { + "description": "Spark History Server configuration for the workload.", + "id": "SparkHistoryServerConfig", "properties": { - "nodeGroupUri": { - "description": "Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1", + "dataprocCluster": { + "description": "Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]", "type": "string" } }, "type": "object" }, - "NodeGroupOperationMetadata": { - "description": "Metadata describing the node group operation.", - "id": "NodeGroupOperationMetadata", + "SparkJob": { + "description": "A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN.", + "id": "SparkJob", "properties": { - "clusterUuid": { - "description": "Output only. Cluster UUID associated with the node group operation.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Output only. Short description of operation.", - "readOnly": true, - "type": "string" - }, - "labels": { - "additionalProperties": { + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { "type": "string" }, - "description": "Output only. Labels associated with the operation.", - "readOnly": true, - "type": "object" - }, - "nodeGroupId": { - "description": "Output only. Node group ID for the operation.", - "readOnly": true, - "type": "string" - }, - "operationType": { - "description": "The operation type.", - "enum": [ - "NODE_GROUP_OPERATION_TYPE_UNSPECIFIED", - "CREATE", - "UPDATE", - "DELETE", - "RESIZE", - "REPAIR", - "UPDATE_LABELS", - "START", - "STOP" - ], - "enumDescriptions": [ - "Node group operation type is unknown.", - "Create node group operation type.", - "Update node group operation type.", - "Delete node group operation type.", - "Resize node group operation type.", - "Repair node group operation type.", - "Update node group label operation type.", - "Start node group operation type.", - "Stop node group operation type." - ], - "type": "string" + "type": "array" }, - "status": { - "$ref": "ClusterOperationStatus", - "description": "Output only. Current operation status.", - "readOnly": true + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + }, + "type": "array" }, - "statusHistory": { - "description": "Output only. The previous operation status.", + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", "items": { - "$ref": "ClusterOperationStatus" + "type": "string" }, - "readOnly": true, "type": "array" }, - "warnings": { - "description": "Output only. Errors encountered during operation execution.", + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.", "items": { "type": "string" }, - "readOnly": true, "type": "array" - } - }, - "type": "object" - }, - "NodeInitializationAction": { - "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", - "id": "NodeInitializationAction", - "properties": { - "executableFile": { - "description": "Required. Cloud Storage URI of executable file.", + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "mainClass": { + "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in SparkJob.jar_file_uris.", "type": "string" }, - "executionTimeout": { - "description": "Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.", - "format": "google-duration", + "mainJarFileUri": { + "description": "The HCFS URI of the jar file that contains the main class.", "type": "string" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", + "type": "object" } }, "type": "object" }, - "NodePool": { - "description": "indicating a list of workers of same type", - "id": "NodePool", + "SparkPlanGraph": { + "description": "A graph used for storing information of an executionPlan of DataFrame.", + "id": "SparkPlanGraph", "properties": { - "id": { - "description": "Required. A unique id of the node pool. Primary and Secondary workers can be specified using special reserved ids PRIMARY_WORKER_POOL and SECONDARY_WORKER_POOL respectively. Aux node pools can be referenced using corresponding pool id.", - "type": "string" - }, - "instanceNames": { - "description": "Name of instances to be repaired. These instances must belong to specified node pool.", + "edges": { "items": { - "type": "string" + "$ref": "SparkPlanGraphEdge" }, "type": "array" }, - "repairAction": { - "description": "Required. Repair action to take on specified resources of the node pool.", - "enum": [ - "REPAIR_ACTION_UNSPECIFIED", - "DELETE" - ], - "enumDescriptions": [ - "No action will be taken by default.", - "delete the specified list of nodes." - ], + "executionId": { + "format": "int64", "type": "string" + }, + "nodes": { + "items": { + "$ref": "SparkPlanGraphNodeWrapper" + }, + "type": "array" } }, "type": "object" }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "id": "Operation", + "SparkPlanGraphCluster": { + "description": "Represents a tree of spark plan.", + "id": "SparkPlanGraphCluster", "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." + "desc": { + "type": "string" }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "metrics": { + "items": { + "$ref": "SqlPlanMetric" }, - "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" + "type": "array" }, "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" + "nodes": { + "items": { + "$ref": "SparkPlanGraphNodeWrapper" }, - "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": "array" + }, + "sparkPlanGraphClusterId": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "OrderedJob": { - "description": "A job executed by the workflow.", - "id": "OrderedJob", + "SparkPlanGraphEdge": { + "description": "Represents a directed edge in the spark plan tree from child to parent.", + "id": "SparkPlanGraphEdge", "properties": { - "flinkJob": { - "$ref": "FlinkJob", - "description": "Optional. Job is a Flink job." - }, - "hadoopJob": { - "$ref": "HadoopJob", - "description": "Optional. Job is a Hadoop job." - }, - "hiveJob": { - "$ref": "HiveJob", - "description": "Optional. Job is a Hive job." - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 32 labels can be associated with a given job.", - "type": "object" - }, - "pigJob": { - "$ref": "PigJob", - "description": "Optional. Job is a Pig job." - }, - "prerequisiteStepIds": { - "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.", - "items": { - "type": "string" - }, - "type": "array" - }, - "prestoJob": { - "$ref": "PrestoJob", - "description": "Optional. Job is a Presto job." - }, - "pysparkJob": { - "$ref": "PySparkJob", - "description": "Optional. Job is a PySpark job." - }, - "scheduling": { - "$ref": "JobScheduling", - "description": "Optional. Job scheduling configuration." - }, - "sparkJob": { - "$ref": "SparkJob", - "description": "Optional. Job is a Spark job." + "fromId": { + "format": "int64", + "type": "string" }, - "sparkRJob": { - "$ref": "SparkRJob", - "description": "Optional. Job is a SparkR job." + "toId": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "SparkPlanGraphNode": { + "description": "Represents a node in the spark plan tree.", + "id": "SparkPlanGraphNode", + "properties": { + "desc": { + "type": "string" }, - "sparkSqlJob": { - "$ref": "SparkSqlJob", - "description": "Optional. Job is a SparkSql job." + "metrics": { + "items": { + "$ref": "SqlPlanMetric" + }, + "type": "array" }, - "stepId": { - "description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.", + "name": { "type": "string" }, - "trinoJob": { - "$ref": "TrinoJob", - "description": "Optional. Job is a Trino job." + "sparkPlanGraphNodeId": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "ParameterValidation": { - "description": "Configuration for parameter validation.", - "id": "ParameterValidation", + "SparkPlanGraphNodeWrapper": { + "description": "Wrapper user to represent either a node or a cluster.", + "id": "SparkPlanGraphNodeWrapper", "properties": { - "regex": { - "$ref": "RegexValidation", - "description": "Validation based on regular expressions." + "cluster": { + "$ref": "SparkPlanGraphCluster" }, - "values": { - "$ref": "ValueValidation", - "description": "Validation based on a list of allowed values." + "node": { + "$ref": "SparkPlanGraphNode" } }, "type": "object" }, - "PeripheralsConfig": { - "description": "Auxiliary services configuration for a workload.", - "id": "PeripheralsConfig", + "SparkRBatch": { + "description": "A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload.", + "id": "SparkRBatch", "properties": { - "metastoreService": { - "description": "Optional. Resource name of an existing Dataproc Metastore service.Example: projects/[project_id]/locations/[region]/services/[service_id]", - "type": "string" + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + }, + "type": "array" }, - "sparkHistoryServerConfig": { - "$ref": "SparkHistoryServerConfig", - "description": "Optional. The Spark History Server configuration for the workload." + "args": { + "description": "Optional. The arguments to pass to the Spark driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mainRFileUri": { + "description": "Required. The HCFS URI of the main R file to use as the driver. Must be a .R or .r file.", + "type": "string" } }, "type": "object" }, - "PigJob": { - "description": "A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", - "id": "PigJob", + "SparkRJob": { + "description": "A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.", + "id": "SparkRJob", "properties": { - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "items": { + "type": "string" + }, + "type": "array" }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "items": { + "type": "string" + }, + "type": "array" + }, + "fileUris": { + "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", "items": { "type": "string" }, @@ -5887,83 +10813,80 @@ "$ref": "LoggingConfig", "description": "Optional. The runtime log config for job execution." }, + "mainRFileUri": { + "description": "Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.", + "type": "string" + }, "properties": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", + "description": "Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", "type": "object" - }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains the Pig queries.", + } + }, + "type": "object" + }, + "SparkRuntimeInfo": { + "id": "SparkRuntimeInfo", + "properties": { + "javaHome": { "type": "string" }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." + "javaVersion": { + "type": "string" }, - "scriptVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).", - "type": "object" + "scalaVersion": { + "type": "string" } }, "type": "object" }, - "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).", - "id": "Policy", + "SparkSqlBatch": { + "description": "A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload.", + "id": "SparkSqlBatch", "properties": { - "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.", + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", "items": { - "$ref": "Binding" + "type": "string" }, "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", + "queryFileUri": { + "description": "Required. The HCFS URI of the script that contains Spark SQL queries to execute.", "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 conditionsImportant: 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" + "queryVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", + "type": "object" } }, "type": "object" }, - "PrestoJob": { - "description": "A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster.", - "id": "PrestoJob", + "SparkSqlJob": { + "description": "A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries.", + "id": "SparkSqlJob", "properties": { - "clientTags": { - "description": "Optional. Presto client tags to attach to this query", + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", "items": { "type": "string" }, "type": "array" }, - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" - }, "loggingConfig": { "$ref": "LoggingConfig", "description": "Optional. The runtime log config for job execution." }, - "outputFormat": { - "description": "Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats", - "type": "string" - }, "properties": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI", + "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API might be overwritten.", "type": "object" }, "queryFileUri": { @@ -5973,560 +10896,755 @@ "queryList": { "$ref": "QueryList", "description": "A list of queries." + }, + "scriptVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", + "type": "object" } }, "type": "object" }, - "PyPiRepositoryConfig": { - "description": "Configuration for PyPi repository", - "id": "PyPiRepositoryConfig", + "SparkStandaloneAutoscalingConfig": { + "description": "Basic autoscaling configurations for Spark Standalone.", + "id": "SparkStandaloneAutoscalingConfig", "properties": { - "pypiRepository": { - "description": "Optional. PyPi repository address", + "gracefulDecommissionTimeout": { + "description": "Required. Timeout for Spark graceful decommissioning of spark workers. Specifies the duration to wait for spark worker to complete spark decommissioning tasks before forcefully removing workers. Only applicable to downscaling operations.Bounds: 0s, 1d.", + "format": "google-duration", + "type": "string" + }, + "removeOnlyIdleWorkers": { + "description": "Optional. Remove only idle workers when scaling down cluster", + "type": "boolean" + }, + "scaleDownFactor": { + "description": "Required. Fraction of required executors to remove from Spark Serverless clusters. A scale-down factor of 1.0 will result in scaling down so that there are no more executors for the Spark Job.(more aggressive scaling). A scale-down factor closer to 0 will result in a smaller magnitude of scaling donw (less aggressive scaling).Bounds: 0.0, 1.0.", + "format": "double", + "type": "number" + }, + "scaleDownMinWorkerFraction": { + "description": "Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", + "format": "double", + "type": "number" + }, + "scaleUpFactor": { + "description": "Required. Fraction of required workers to add to Spark Standalone clusters. A scale-up factor of 1.0 will result in scaling up so that there are no more required workers for the Spark Job (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.", + "format": "double", + "type": "number" + }, + "scaleUpMinWorkerFraction": { + "description": "Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "SparkWrapperObject": { + "description": "Outer message that contains the data obtained from spark listener, packaged with information that is required to process it.", + "id": "SparkWrapperObject", + "properties": { + "appSummary": { + "$ref": "AppSummary" + }, + "applicationEnvironmentInfo": { + "$ref": "ApplicationEnvironmentInfo" + }, + "applicationId": { + "description": "Application Id created by Spark.", + "type": "string" + }, + "applicationInfo": { + "$ref": "ApplicationInfo" + }, + "eventTimestamp": { + "description": "VM Timestamp associated with the data object.", + "format": "google-datetime", "type": "string" + }, + "executorStageSummary": { + "$ref": "ExecutorStageSummary" + }, + "executorSummary": { + "$ref": "ExecutorSummary" + }, + "jobData": { + "$ref": "JobData" + }, + "poolData": { + "$ref": "PoolData" + }, + "processSummary": { + "$ref": "ProcessSummary" + }, + "rddOperationGraph": { + "$ref": "RddOperationGraph" + }, + "rddStorageInfo": { + "$ref": "RddStorageInfo" + }, + "resourceProfileInfo": { + "$ref": "ResourceProfileInfo" + }, + "sparkPlanGraph": { + "$ref": "SparkPlanGraph" + }, + "speculationStageSummary": { + "$ref": "SpeculationStageSummary" + }, + "sqlExecutionUiData": { + "$ref": "SqlExecutionUiData" + }, + "stageData": { + "$ref": "StageData" + }, + "streamBlockData": { + "$ref": "StreamBlockData" + }, + "streamingQueryData": { + "$ref": "StreamingQueryData" + }, + "streamingQueryProgress": { + "$ref": "StreamingQueryProgress" + }, + "taskData": { + "$ref": "TaskData" } }, "type": "object" }, - "PySparkBatch": { - "description": "A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload.", - "id": "PySparkBatch", + "SpeculationStageSummary": { + "description": "Details of the speculation task when speculative execution is enabled.", + "id": "SpeculationStageSummary", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" + "numActiveTasks": { + "format": "int32", + "type": "integer" }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", - "items": { - "type": "string" - }, - "type": "array" + "numCompletedTasks": { + "format": "int32", + "type": "integer" }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", - "items": { - "type": "string" - }, - "type": "array" + "numFailedTasks": { + "format": "int32", + "type": "integer" + }, + "numKilledTasks": { + "format": "int32", + "type": "integer" }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.", - "items": { - "type": "string" - }, - "type": "array" + "numTasks": { + "format": "int32", + "type": "integer" }, - "mainPythonFileUri": { - "description": "Required. The HCFS URI of the main Python file to use as the Spark driver. Must be a .py file.", - "type": "string" + "stageAttemptId": { + "format": "int32", + "type": "integer" }, - "pythonFileUris": { - "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", - "items": { - "type": "string" - }, - "type": "array" + "stageId": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "PySparkJob": { - "description": "A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.", - "id": "PySparkJob", + "SqlExecutionUiData": { + "description": "SQL Execution Data", + "id": "SqlExecutionUiData", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" + "completionTime": { + "format": "google-datetime", + "type": "string" }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "items": { + "description": { + "type": "string" + }, + "details": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "executionId": { + "format": "int64", + "type": "string" + }, + "jobs": { + "additionalProperties": { + "enum": [ + "JOB_EXECUTION_STATUS_UNSPECIFIED", + "JOB_EXECUTION_STATUS_RUNNING", + "JOB_EXECUTION_STATUS_SUCCEEDED", + "JOB_EXECUTION_STATUS_FAILED", + "JOB_EXECUTION_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "" + ], "type": "string" }, - "type": "array" + "type": "object" }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", - "items": { + "metricValues": { + "additionalProperties": { "type": "string" }, - "type": "array" + "type": "object" }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", + "metricValuesIsNull": { + "type": "boolean" + }, + "metrics": { "items": { - "type": "string" + "$ref": "SqlPlanMetric" }, "type": "array" }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." - }, - "mainPythonFileUri": { - "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.", - "type": "string" - }, - "properties": { + "modifiedConfigs": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", "type": "object" }, - "pythonFileUris": { - "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", + "physicalPlanDescription": { + "type": "string" + }, + "rootExecutionId": { + "format": "int64", + "type": "string" + }, + "stages": { "items": { + "format": "int64", "type": "string" }, "type": "array" + }, + "submissionTime": { + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "QueryList": { - "description": "A list of queries to run on a cluster.", - "id": "QueryList", + "SqlPlanMetric": { + "description": "Metrics related to SQL execution.", + "id": "SqlPlanMetric", "properties": { - "queries": { - "description": "Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob: \"hiveJob\": { \"queryList\": { \"queries\": [ \"query1\", \"query2\", \"query3;query4\", ] } } ", - "items": { - "type": "string" - }, - "type": "array" + "accumulatorId": { + "format": "int64", + "type": "string" + }, + "metricType": { + "type": "string" + }, + "name": { + "type": "string" } }, "type": "object" }, - "RegexValidation": { - "description": "Validation based on regular expressions.", - "id": "RegexValidation", + "StageAttemptTasksSummary": { + "description": "Data related to tasks summary for a Spark Stage Attempt", + "id": "StageAttemptTasksSummary", "properties": { - "regexes": { - "description": "Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).", - "items": { - "type": "string" - }, - "type": "array" + "applicationId": { + "type": "string" + }, + "numFailedTasks": { + "format": "int32", + "type": "integer" + }, + "numKilledTasks": { + "format": "int32", + "type": "integer" + }, + "numPendingTasks": { + "format": "int32", + "type": "integer" + }, + "numRunningTasks": { + "format": "int32", + "type": "integer" + }, + "numSuccessTasks": { + "format": "int32", + "type": "integer" + }, + "numTasks": { + "format": "int32", + "type": "integer" + }, + "stageAttemptId": { + "format": "int32", + "type": "integer" + }, + "stageId": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "RepairClusterRequest": { - "description": "A request to repair a cluster.", - "id": "RepairClusterRequest", + "StageData": { + "description": "Data corresponding to a stage.", + "id": "StageData", "properties": { - "clusterUuid": { - "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", + "accumulatorUpdates": { + "items": { + "$ref": "AccumulableInfo" + }, + "type": "array" + }, + "completionTime": { + "format": "google-datetime", "type": "string" }, - "gracefulDecommissionTimeout": { - "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning facilitates the removal of cluster nodes without interrupting jobs in progress. The timeout specifies the amount of time to wait for jobs finish before forcefully removing nodes. The default timeout is 0 for forceful decommissioning, and the maximum timeout period is 1 day. (see JSON Mapping—Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).graceful_decommission_timeout is supported in Dataproc image versions 1.2+.", - "format": "google-duration", + "description": { "type": "string" }, - "nodePools": { - "description": "Optional. Node pools and corresponding repair action to be taken. All node pools should be unique in this request. i.e. Multiple entries for the same node pool id are not allowed.", - "items": { - "$ref": "NodePool" + "details": { + "type": "string" + }, + "executorMetricsDistributions": { + "$ref": "ExecutorMetricsDistributions" + }, + "executorSummary": { + "additionalProperties": { + "$ref": "ExecutorStageSummary" }, - "type": "array" + "type": "object" }, - "parentOperationId": { - "description": "Optional. operation id of the parent operation sending the repair request", + "failureReason": { "type": "string" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two RepairClusterRequests with the same ID, the second request is ignored, and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "firstTaskLaunchedTime": { + "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "RepairNodeGroupRequest": { - "id": "RepairNodeGroupRequest", - "properties": { - "instanceNames": { - "description": "Required. Name of instances to be repaired. These instances must belong to specified node pool.", + }, + "isShufflePushEnabled": { + "type": "boolean" + }, + "jobIds": { "items": { + "format": "int64", "type": "string" }, "type": "array" }, - "repairAction": { - "description": "Required. Repair action to take on specified resources of the node pool.", - "enum": [ - "REPAIR_ACTION_UNSPECIFIED", - "REPLACE" - ], - "enumDescriptions": [ - "No action will be taken by default.", - "replace the specified list of nodes." - ], - "type": "string" + "killedTasksSummary": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two RepairNodeGroupRequest with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "locality": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "type": "object" + }, + "name": { "type": "string" - } - }, - "type": "object" - }, - "RepositoryConfig": { - "description": "Configuration for dependency repositories", - "id": "RepositoryConfig", - "properties": { - "pypiRepositoryConfig": { - "$ref": "PyPiRepositoryConfig", - "description": "Optional. Configuration for PyPi repository." - } - }, - "type": "object" - }, - "ReservationAffinity": { - "description": "Reservation Affinity for consuming Zonal reservation.", - "id": "ReservationAffinity", - "properties": { - "consumeReservationType": { - "description": "Optional. Type of reservation to consume", + }, + "numActiveTasks": { + "format": "int32", + "type": "integer" + }, + "numCompleteTasks": { + "format": "int32", + "type": "integer" + }, + "numCompletedIndices": { + "format": "int32", + "type": "integer" + }, + "numFailedTasks": { + "format": "int32", + "type": "integer" + }, + "numKilledTasks": { + "format": "int32", + "type": "integer" + }, + "numTasks": { + "format": "int32", + "type": "integer" + }, + "parentStageIds": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "peakExecutorMetrics": { + "$ref": "ExecutorMetrics" + }, + "rddIds": { + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "resourceProfileId": { + "format": "int32", + "type": "integer" + }, + "schedulingPool": { + "type": "string" + }, + "shuffleMergersCount": { + "format": "int32", + "type": "integer" + }, + "speculationSummary": { + "$ref": "SpeculationStageSummary" + }, + "stageAttemptId": { + "format": "int32", + "type": "integer" + }, + "stageId": { + "format": "int64", + "type": "string" + }, + "stageMetrics": { + "$ref": "StageMetrics" + }, + "status": { "enum": [ - "TYPE_UNSPECIFIED", - "NO_RESERVATION", - "ANY_RESERVATION", - "SPECIFIC_RESERVATION" + "STAGE_STATUS_UNSPECIFIED", + "STAGE_STATUS_ACTIVE", + "STAGE_STATUS_COMPLETE", + "STAGE_STATUS_FAILED", + "STAGE_STATUS_PENDING", + "STAGE_STATUS_SKIPPED" ], "enumDescriptions": [ "", - "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 reservation resource.", + "submissionTime": { + "format": "google-datetime", "type": "string" }, - "values": { - "description": "Optional. Corresponds to the label values of reservation resource.", - "items": { - "type": "string" + "taskQuantileMetrics": { + "$ref": "TaskQuantileMetrics", + "description": "Summary metrics fields. These are included in response only if present in summary_metrics_mask field in request" + }, + "tasks": { + "additionalProperties": { + "$ref": "TaskData" }, - "type": "array" + "type": "object" } }, "type": "object" }, - "ResizeNodeGroupRequest": { - "description": "A request to resize a node group.", - "id": "ResizeNodeGroupRequest", + "StageInputMetrics": { + "description": "Metrics about the input read by the stage.", + "id": "StageInputMetrics", "properties": { - "gracefulDecommissionTimeout": { - "description": "Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning) allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.", - "format": "google-duration", - "type": "string" - }, - "parentOperationId": { - "description": "Optional. operation id of the parent operation sending the resize request", + "bytesRead": { + "format": "int64", "type": "string" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "recordsRead": { + "format": "int64", "type": "string" - }, - "size": { - "description": "Required. The number of running instances for the node group to maintain. The group adds or removes instances to maintain the number of instances specified by this parameter.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "RuntimeConfig": { - "description": "Runtime configuration for a workload.", - "id": "RuntimeConfig", + "StageMetrics": { + "description": "Stage Level Aggregated Metrics", + "id": "StageMetrics", "properties": { - "autotuningConfig": { - "$ref": "AutotuningConfig", - "description": "Optional. Autotuning configuration of the workload." + "diskBytesSpilled": { + "format": "int64", + "type": "string" }, - "cohort": { - "description": "Optional. Cohort identifier. Identifies families of the workloads having the same shape, e.g. daily ETL jobs.", + "executorCpuTimeNanos": { + "format": "int64", "type": "string" }, - "containerImage": { - "description": "Optional. Optional custom container image for the job runtime environment. If not specified, a default container image will be used.", + "executorDeserializeCpuTimeNanos": { + "format": "int64", "type": "string" }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, which are used to configure workload execution.", - "type": "object" + "executorDeserializeTimeMillis": { + "format": "int64", + "type": "string" }, - "repositoryConfig": { - "$ref": "RepositoryConfig", - "description": "Optional. Dependency repository configuration." + "executorRunTimeMillis": { + "format": "int64", + "type": "string" }, - "version": { - "description": "Optional. Version of the batch runtime.", + "jvmGcTimeMillis": { + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "RuntimeInfo": { - "description": "Runtime information about workload execution.", - "id": "RuntimeInfo", - "properties": { - "approximateUsage": { - "$ref": "UsageMetrics", - "description": "Output only. Approximate workload resource usage, calculated when the workload completes (see Dataproc Serverless pricing (https://cloud.google.com/dataproc-serverless/pricing)).Note: This metric calculation may change in the future, for example, to capture cumulative workload resource consumption during workload execution (see the Dataproc Serverless release notes (https://cloud.google.com/dataproc-serverless/docs/release-notes) for announcements, changes, fixes and other Dataproc developments).", - "readOnly": true }, - "currentUsage": { - "$ref": "UsageSnapshot", - "description": "Output only. Snapshot of current workload resource usage.", - "readOnly": true + "memoryBytesSpilled": { + "format": "int64", + "type": "string" }, - "diagnosticOutputUri": { - "description": "Output only. A URI pointing to the location of the diagnostics tarball.", - "readOnly": true, + "peakExecutionMemoryBytes": { + "format": "int64", "type": "string" }, - "endpoints": { - "additionalProperties": { - "type": "string" - }, - "description": "Output only. Map of remote access endpoints (such as web interfaces and APIs) to their URIs.", - "readOnly": true, - "type": "object" + "resultSerializationTimeMillis": { + "format": "int64", + "type": "string" }, - "outputUri": { - "description": "Output only. A URI pointing to the location of the stdout and stderr of the workload.", - "readOnly": true, + "resultSize": { + "format": "int64", "type": "string" + }, + "stageInputMetrics": { + "$ref": "StageInputMetrics" + }, + "stageOutputMetrics": { + "$ref": "StageOutputMetrics" + }, + "stageShuffleReadMetrics": { + "$ref": "StageShuffleReadMetrics" + }, + "stageShuffleWriteMetrics": { + "$ref": "StageShuffleWriteMetrics" } }, "type": "object" }, - "SecurityConfig": { - "description": "Security related configuration, including encryption, Kerberos, etc.", - "id": "SecurityConfig", + "StageOutputMetrics": { + "description": "Metrics about the output written by the stage.", + "id": "StageOutputMetrics", "properties": { - "identityConfig": { - "$ref": "IdentityConfig", - "description": "Optional. Identity related configuration, including service account based secure multi-tenancy user mappings." + "bytesWritten": { + "format": "int64", + "type": "string" }, - "kerberosConfig": { - "$ref": "KerberosConfig", - "description": "Optional. Kerberos related configuration." + "recordsWritten": { + "format": "int64", + "type": "string" } }, "type": "object" }, - "Session": { - "description": "A representation of a session.", - "id": "Session", + "StageShufflePushReadMetrics": { + "id": "StageShufflePushReadMetrics", "properties": { - "createTime": { - "description": "Output only. The time when the session was created.", - "format": "google-datetime", - "readOnly": true, + "corruptMergedBlockChunks": { + "format": "int64", "type": "string" }, - "creator": { - "description": "Output only. The email address of the user who created the session.", - "readOnly": true, + "localMergedBlocksFetched": { + "format": "int64", "type": "string" }, - "environmentConfig": { - "$ref": "EnvironmentConfig", - "description": "Optional. Environment configuration for the session execution." + "localMergedBytesRead": { + "format": "int64", + "type": "string" }, - "jupyterSession": { - "$ref": "JupyterConfig", - "description": "Optional. Jupyter session config." + "localMergedChunksFetched": { + "format": "int64", + "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.", - "type": "object" + "mergedFetchFallbackCount": { + "format": "int64", + "type": "string" }, - "name": { - "description": "Required. The resource name of the session.", + "remoteMergedBlocksFetched": { + "format": "int64", "type": "string" }, - "runtimeConfig": { - "$ref": "RuntimeConfig", - "description": "Optional. Runtime configuration for the session execution." + "remoteMergedBytesRead": { + "format": "int64", + "type": "string" }, - "runtimeInfo": { - "$ref": "RuntimeInfo", - "description": "Output only. Runtime information about session execution.", - "readOnly": true + "remoteMergedChunksFetched": { + "format": "int64", + "type": "string" }, - "sessionTemplate": { - "description": "Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.", + "remoteMergedReqsDuration": { + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "StageShuffleReadMetrics": { + "description": "Shuffle data read for the stage.", + "id": "StageShuffleReadMetrics", + "properties": { + "bytesRead": { + "format": "int64", "type": "string" }, - "sparkConnectSession": { - "$ref": "SparkConnectConfig", - "description": "Optional. Spark connect session config." + "fetchWaitTimeMillis": { + "format": "int64", + "type": "string" }, - "state": { - "description": "Output only. A state of the session.", - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "TERMINATING", - "TERMINATED", - "FAILED" - ], - "enumDescriptions": [ - "The session state is unknown.", - "The session is created prior to running.", - "The session is running.", - "The session is terminating.", - "The session is terminated successfully.", - "The session is no longer running due to an error." - ], - "readOnly": true, + "localBlocksFetched": { + "format": "int64", "type": "string" }, - "stateHistory": { - "description": "Output only. Historical state information for the session.", - "items": { - "$ref": "SessionStateHistory" - }, - "readOnly": true, - "type": "array" + "localBytesRead": { + "format": "int64", + "type": "string" }, - "stateMessage": { - "description": "Output only. Session state details, such as the failure description if the state is FAILED.", - "readOnly": true, + "recordsRead": { + "format": "int64", "type": "string" }, - "stateTime": { - "description": "Output only. The time when the session entered the current state.", - "format": "google-datetime", - "readOnly": true, + "remoteBlocksFetched": { + "format": "int64", "type": "string" }, - "user": { - "description": "Optional. The email address of the user who owns the session.", + "remoteBytesRead": { + "format": "int64", + "type": "string" + }, + "remoteBytesReadToDisk": { + "format": "int64", + "type": "string" + }, + "remoteReqsDuration": { + "format": "int64", + "type": "string" + }, + "stageShufflePushReadMetrics": { + "$ref": "StageShufflePushReadMetrics" + } + }, + "type": "object" + }, + "StageShuffleWriteMetrics": { + "description": "Shuffle data written for the stage.", + "id": "StageShuffleWriteMetrics", + "properties": { + "bytesWritten": { + "format": "int64", + "type": "string" + }, + "recordsWritten": { + "format": "int64", "type": "string" }, - "uuid": { - "description": "Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session.", - "readOnly": true, + "writeTimeNanos": { + "format": "int64", "type": "string" } }, "type": "object" }, - "SessionOperationMetadata": { - "description": "Metadata describing the Session operation.", - "id": "SessionOperationMetadata", + "StagesSummary": { + "description": "Data related to Stages page summary", + "id": "StagesSummary", "properties": { - "createTime": { - "description": "The time when the operation was created.", - "format": "google-datetime", + "applicationId": { "type": "string" }, - "description": { - "description": "Short description of the operation.", - "type": "string" + "numActiveStages": { + "format": "int32", + "type": "integer" }, - "doneTime": { - "description": "The time when the operation was finished.", - "format": "google-datetime", - "type": "string" + "numCompletedStages": { + "format": "int32", + "type": "integer" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels associated with the operation.", - "type": "object" + "numFailedStages": { + "format": "int32", + "type": "integer" }, - "operationType": { - "description": "The operation type.", - "enum": [ - "SESSION_OPERATION_TYPE_UNSPECIFIED", - "CREATE", - "TERMINATE", - "DELETE" - ], - "enumDescriptions": [ - "Session operation type is unknown.", - "Create Session operation type.", - "Terminate Session operation type.", - "Delete Session operation type." - ], - "type": "string" + "numPendingStages": { + "format": "int32", + "type": "integer" }, - "session": { - "description": "Name of the session for the operation.", + "numSkippedStages": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "StartClusterRequest": { + "description": "A request to start a cluster.", + "id": "StartClusterRequest", + "properties": { + "clusterUuid": { + "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", "type": "string" }, - "sessionUuid": { - "description": "Session UUID for the operation.", + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two StartClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" - }, - "warnings": { - "description": "Warnings encountered during operation execution.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "SessionStateHistory": { + "StartupConfig": { + "description": "Configuration to handle the startup of instances during cluster create and update process.", + "id": "StartupConfig", + "properties": { + "requiredRegistrationFraction": { + "description": "Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "StateHistory": { "description": "Historical state information.", - "id": "SessionStateHistory", + "id": "StateHistory", "properties": { "state": { - "description": "Output only. The state of the session at this point in the session history.", + "description": "Output only. The state of the batch at this point in history.", "enum": [ "STATE_UNSPECIFIED", - "CREATING", - "ACTIVE", - "TERMINATING", - "TERMINATED", + "PENDING", + "RUNNING", + "CANCELLING", + "CANCELLED", + "SUCCEEDED", "FAILED" ], "enumDescriptions": [ - "The session state is unknown.", - "The session is created prior to running.", - "The session is running.", - "The session is terminating.", - "The session is terminated successfully.", - "The session is no longer running due to an error." + "The batch state is unknown.", + "The batch is created before running.", + "The batch is running.", + "The batch is cancelling.", + "The batch cancellation was successful.", + "The batch completed successfully.", + "The batch is no longer running due to an error." ], "readOnly": true, "type": "string" }, "stateMessage": { - "description": "Output only. Details about the state at this point in the session history.", + "description": "Output only. Details about the state at this point in history.", "readOnly": true, "type": "string" }, "stateStartTime": { - "description": "Output only. The time when the session entered the historical state.", + "description": "Output only. The time when the batch entered the historical state.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6534,565 +11652,569 @@ }, "type": "object" }, - "SessionTemplate": { - "description": "A representation of a session template.", - "id": "SessionTemplate", + "StateOperatorProgress": { + "id": "StateOperatorProgress", "properties": { - "createTime": { - "description": "Output only. The time when the template was created.", - "format": "google-datetime", - "readOnly": true, + "allRemovalsTimeMs": { + "format": "int64", "type": "string" }, - "creator": { - "description": "Output only. The email address of the user who created the template.", - "readOnly": true, + "allUpdatesTimeMs": { + "format": "int64", "type": "string" }, - "description": { - "description": "Optional. Brief description of the template.", + "commitTimeMs": { + "format": "int64", "type": "string" }, - "environmentConfig": { - "$ref": "EnvironmentConfig", - "description": "Optional. Environment configuration for session execution." - }, - "jupyterSession": { - "$ref": "JupyterConfig", - "description": "Optional. Jupyter session config." - }, - "labels": { + "customMetrics": { "additionalProperties": { + "format": "int64", "type": "string" }, - "description": "Optional. Labels to associate with sessions created using this template. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty, but, if present, must contain 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session.", "type": "object" }, - "name": { - "description": "Required. The resource name of the session template.", + "memoryUsedBytes": { + "format": "int64", "type": "string" }, - "runtimeConfig": { - "$ref": "RuntimeConfig", - "description": "Optional. Runtime configuration for session execution." + "numRowsDroppedByWatermark": { + "format": "int64", + "type": "string" }, - "sparkConnectSession": { - "$ref": "SparkConnectConfig", - "description": "Optional. Spark connect session config." + "numRowsRemoved": { + "format": "int64", + "type": "string" }, - "updateTime": { - "description": "Output only. The time the template was last updated.", - "format": "google-datetime", - "readOnly": true, + "numRowsTotal": { + "format": "int64", "type": "string" }, - "uuid": { - "description": "Output only. A session template UUID (Unique Universal Identifier). The service generates this value when it creates the session template.", - "readOnly": true, + "numRowsUpdated": { + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for SetIamPolicy method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." - } - }, - "type": "object" - }, - "ShieldedInstanceConfig": { - "description": "Shielded Instance Config for clusters using Compute Engine Shielded VMs (https://cloud.google.com/security/shielded-cloud/shielded-vm).", - "id": "ShieldedInstanceConfig", - "properties": { - "enableIntegrityMonitoring": { - "description": "Optional. Defines whether instances have integrity monitoring enabled.", - "type": "boolean" }, - "enableSecureBoot": { - "description": "Optional. Defines whether instances have Secure Boot enabled.", - "type": "boolean" + "numShufflePartitions": { + "format": "int64", + "type": "string" }, - "enableVtpm": { - "description": "Optional. Defines whether instances have the vTPM enabled.", - "type": "boolean" + "numStateStoreInstances": { + "format": "int64", + "type": "string" + }, + "operatorName": { + "type": "string" } }, "type": "object" }, - "SoftwareConfig": { - "description": "Specifies the selection and config of software inside the cluster.", - "id": "SoftwareConfig", + "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": { - "imageVersion": { - "description": "Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported-dataproc-image-versions), such as \"1.2\" (including a subminor version, such as \"1.2.29\"), or the \"preview\" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.", - "type": "string" + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" }, - "optionalComponents": { - "description": "Optional. The set of components to activate on the cluster.", + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { - "enum": [ - "COMPONENT_UNSPECIFIED", - "ANACONDA", - "DOCKER", - "DRUID", - "FLINK", - "HBASE", - "HIVE_WEBHCAT", - "HUDI", - "JUPYTER", - "PRESTO", - "TRINO", - "RANGER", - "SOLR", - "ZEPPELIN", - "ZOOKEEPER" - ], - "enumDescriptions": [ - "Unspecified component. Specifying this will cause Cluster creation to fail.", - "The Anaconda component is no longer supported or applicable to supported Dataproc on Compute Engine image versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-version-clusters#supported-dataproc-image-versions). It cannot be activated on clusters created with supported Dataproc on Compute Engine image versions.", - "Docker", - "The Druid query engine. (alpha)", - "Flink", - "HBase. (beta)", - "The Hive Web HCatalog (the REST service for accessing HCatalog).", - "Hudi.", - "The Jupyter Notebook.", - "The Presto query engine.", - "The Trino query engine.", - "The Ranger service.", - "The Solr service.", - "The Zeppelin notebook.", - "The Zookeeper service." - ], - "type": "string" + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" }, "type": "array" }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).", - "type": "object" + "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" }, - "SparkBatch": { - "description": "A configuration for running an Apache Spark (https://spark.apache.org/) batch workload.", - "id": "SparkBatch", + "StopClusterRequest": { + "description": "A request to stop a cluster.", + "id": "StopClusterRequest", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" + "clusterUuid": { + "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", + "type": "string" }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", - "items": { - "type": "string" - }, - "type": "array" + "requestId": { + "description": "Optional. A unique ID used to identify the request. If the server receives two StopClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + } + }, + "type": "object" + }, + "StreamBlockData": { + "description": "Stream Block Data.", + "id": "StreamBlockData", + "properties": { + "deserialized": { + "type": "boolean" }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", - "items": { - "type": "string" - }, - "type": "array" + "diskSize": { + "format": "int64", + "type": "string" }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the classpath of the Spark driver and tasks.", - "items": { - "type": "string" - }, - "type": "array" + "executorId": { + "type": "string" }, - "mainClass": { - "description": "Optional. The name of the driver main class. The jar file that contains the class must be in the classpath or specified in jar_file_uris.", + "hostPort": { "type": "string" }, - "mainJarFileUri": { - "description": "Optional. The HCFS URI of the jar file that contains the main class.", + "memSize": { + "format": "int64", + "type": "string" + }, + "name": { + "type": "string" + }, + "storageLevel": { "type": "string" + }, + "useDisk": { + "type": "boolean" + }, + "useMemory": { + "type": "boolean" } }, "type": "object" }, - "SparkConnectConfig": { - "description": "Spark connect configuration for an interactive session.", - "id": "SparkConnectConfig", - "properties": {}, - "type": "object" - }, - "SparkHistoryServerConfig": { - "description": "Spark History Server configuration for the workload.", - "id": "SparkHistoryServerConfig", + "StreamingQueryData": { + "description": "Streaming", + "id": "StreamingQueryData", "properties": { - "dataprocCluster": { - "description": "Optional. Resource name of an existing Dataproc Cluster to act as a Spark History Server for the workload.Example: projects/[project_id]/regions/[region]/clusters/[cluster_name]", + "endTimestamp": { + "format": "int64", + "type": "string" + }, + "exception": { + "type": "string" + }, + "isActive": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "runId": { + "type": "string" + }, + "startTimestamp": { + "format": "int64", + "type": "string" + }, + "streamingQueryId": { "type": "string" } }, "type": "object" }, - "SparkJob": { - "description": "A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN.", - "id": "SparkJob", + "StreamingQueryProgress": { + "id": "StreamingQueryProgress", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" + "batchDuration": { + "format": "int64", + "type": "string" }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "items": { - "type": "string" - }, - "type": "array" + "batchId": { + "format": "int64", + "type": "string" }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", - "items": { + "durationMillis": { + "additionalProperties": { + "format": "int64", "type": "string" }, - "type": "array" + "type": "object" }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.", - "items": { + "eventTime": { + "additionalProperties": { "type": "string" }, - "type": "array" - }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." - }, - "mainClass": { - "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in SparkJob.jar_file_uris.", - "type": "string" + "type": "object" }, - "mainJarFileUri": { - "description": "The HCFS URI of the jar file that contains the main class.", + "name": { "type": "string" }, - "properties": { + "observedMetrics": { "additionalProperties": { "type": "string" }, - "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", "type": "object" - } - }, - "type": "object" - }, - "SparkRBatch": { - "description": "A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload.", - "id": "SparkRBatch", - "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" }, - "args": { - "description": "Optional. The arguments to pass to the Spark driver. Do not include arguments that can be set as batch properties, such as --conf, since a collision can occur that causes an incorrect batch submission.", + "runId": { + "type": "string" + }, + "sink": { + "$ref": "SinkProgress" + }, + "sources": { "items": { - "type": "string" + "$ref": "SourceProgress" }, "type": "array" }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor.", + "stateOperators": { "items": { - "type": "string" + "$ref": "StateOperatorProgress" }, "type": "array" }, - "mainRFileUri": { - "description": "Required. The HCFS URI of the main R file to use as the driver. Must be a .R or .r file.", + "streamingQueryProgressId": { + "type": "string" + }, + "timestamp": { "type": "string" } }, "type": "object" }, - "SparkRJob": { - "description": "A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN.", - "id": "SparkRJob", + "SubmitJobRequest": { + "description": "A request to submit a job.", + "id": "SubmitJobRequest", "properties": { - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "items": { - "type": "string" - }, - "type": "array" - }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "items": { - "type": "string" - }, - "type": "array" - }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks.", - "items": { - "type": "string" - }, - "type": "array" + "job": { + "$ref": "Job", + "description": "Required. The job resource." }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." + "requestId": { + "description": "Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "type": "string" + } + }, + "type": "object" + }, + "SummarizeSessionSparkApplicationExecutorsResponse": { + "description": "Consolidated summary of executors for a Spark Application.", + "id": "SummarizeSessionSparkApplicationExecutorsResponse", + "properties": { + "activeExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Consolidated summary for active executors." }, - "mainRFileUri": { - "description": "Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.", + "applicationId": { + "description": "Spark Application Id", "type": "string" }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", - "type": "object" + "deadExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Consolidated summary for dead executors." + }, + "totalExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Overall consolidated summary for all executors." } }, "type": "object" }, - "SparkSqlBatch": { - "description": "A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload.", - "id": "SparkSqlBatch", + "SummarizeSessionSparkApplicationJobsResponse": { + "description": "Summary of a Spark Application jobs.", + "id": "SummarizeSessionSparkApplicationJobsResponse", "properties": { - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", - "items": { - "type": "string" - }, - "type": "array" + "jobsSummary": { + "$ref": "JobsSummary", + "description": "Summary of a Spark Application Jobs" + } + }, + "type": "object" + }, + "SummarizeSessionSparkApplicationStageAttemptTasksResponse": { + "description": "Summary of tasks for a Spark Application stage attempt.", + "id": "SummarizeSessionSparkApplicationStageAttemptTasksResponse", + "properties": { + "stageAttemptTasksSummary": { + "$ref": "StageAttemptTasksSummary", + "description": "Summary of tasks for a Spark Application Stage Attempt" + } + }, + "type": "object" + }, + "SummarizeSessionSparkApplicationStagesResponse": { + "description": "Summary of a Spark Application stages.", + "id": "SummarizeSessionSparkApplicationStagesResponse", + "properties": { + "stagesSummary": { + "$ref": "StagesSummary", + "description": "Summary of a Spark Application Stages" + } + }, + "type": "object" + }, + "SummarizeSparkApplicationExecutorsResponse": { + "description": "Consolidated summary of executors for a Spark Application.", + "id": "SummarizeSparkApplicationExecutorsResponse", + "properties": { + "activeExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Consolidated summary for active executors." }, - "queryFileUri": { - "description": "Required. The HCFS URI of the script that contains Spark SQL queries to execute.", + "applicationId": { + "description": "Spark Application Id", "type": "string" }, - "queryVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", - "type": "object" + "deadExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Consolidated summary for dead executors." + }, + "totalExecutorSummary": { + "$ref": "ConsolidatedExecutorSummary", + "description": "Overall consolidated summary for all executors." + } + }, + "type": "object" + }, + "SummarizeSparkApplicationJobsResponse": { + "description": "Summary of a Spark Application jobs.", + "id": "SummarizeSparkApplicationJobsResponse", + "properties": { + "jobsSummary": { + "$ref": "JobsSummary", + "description": "Summary of a Spark Application Jobs" + } + }, + "type": "object" + }, + "SummarizeSparkApplicationStageAttemptTasksResponse": { + "description": "Summary of tasks for a Spark Application stage attempt.", + "id": "SummarizeSparkApplicationStageAttemptTasksResponse", + "properties": { + "stageAttemptTasksSummary": { + "$ref": "StageAttemptTasksSummary", + "description": "Summary of tasks for a Spark Application Stage Attempt" } }, "type": "object" }, - "SparkSqlJob": { - "description": "A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries.", - "id": "SparkSqlJob", + "SummarizeSparkApplicationStagesResponse": { + "description": "Summary of a Spark Application stages.", + "id": "SummarizeSparkApplicationStagesResponse", "properties": { - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", + "stagesSummary": { + "$ref": "StagesSummary", + "description": "Summary of a Spark Application Stages" + } + }, + "type": "object" + }, + "TaskData": { + "description": "Data corresponding to tasks created by spark.", + "id": "TaskData", + "properties": { + "accumulatorUpdates": { "items": { - "type": "string" + "$ref": "AccumulableInfo" }, "type": "array" }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." + "attempt": { + "format": "int32", + "type": "integer" }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API might be overwritten.", - "type": "object" + "durationMillis": { + "format": "int64", + "type": "string" }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains SQL queries.", + "errorMessage": { "type": "string" }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." + "executorId": { + "type": "string" }, - "scriptVariables": { + "executorLogs": { "additionalProperties": { "type": "string" }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", "type": "object" - } - }, - "type": "object" - }, - "SparkStandaloneAutoscalingConfig": { - "description": "Basic autoscaling configurations for Spark Standalone.", - "id": "SparkStandaloneAutoscalingConfig", - "properties": { - "gracefulDecommissionTimeout": { - "description": "Required. Timeout for Spark graceful decommissioning of spark workers. Specifies the duration to wait for spark worker to complete spark decommissioning tasks before forcefully removing workers. Only applicable to downscaling operations.Bounds: 0s, 1d.", - "format": "google-duration", + }, + "gettingResultTimeMillis": { + "format": "int64", "type": "string" }, - "removeOnlyIdleWorkers": { - "description": "Optional. Remove only idle workers when scaling down cluster", + "hasMetrics": { "type": "boolean" }, - "scaleDownFactor": { - "description": "Required. Fraction of required executors to remove from Spark Serverless clusters. A scale-down factor of 1.0 will result in scaling down so that there are no more executors for the Spark Job.(more aggressive scaling). A scale-down factor closer to 0 will result in a smaller magnitude of scaling donw (less aggressive scaling).Bounds: 0.0, 1.0.", - "format": "double", - "type": "number" + "host": { + "type": "string" }, - "scaleDownMinWorkerFraction": { - "description": "Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", - "format": "double", - "type": "number" + "index": { + "format": "int32", + "type": "integer" }, - "scaleUpFactor": { - "description": "Required. Fraction of required workers to add to Spark Standalone clusters. A scale-up factor of 1.0 will result in scaling up so that there are no more required workers for the Spark Job (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling).Bounds: 0.0, 1.0.", - "format": "double", - "type": "number" + "launchTime": { + "format": "google-datetime", + "type": "string" }, - "scaleUpMinWorkerFraction": { - "description": "Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change.Bounds: 0.0, 1.0. Default: 0.0.", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "StartClusterRequest": { - "description": "A request to start a cluster.", - "id": "StartClusterRequest", - "properties": { - "clusterUuid": { - "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", + "partitionId": { + "format": "int32", + "type": "integer" + }, + "resultFetchStart": { + "format": "google-datetime", "type": "string" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two StartClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StartClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "schedulerDelayMillis": { + "format": "int64", "type": "string" - } - }, - "type": "object" - }, - "StartupConfig": { - "description": "Configuration to handle the startup of instances during cluster create and update process.", - "id": "StartupConfig", - "properties": { - "requiredRegistrationFraction": { - "description": "Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).", - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "StateHistory": { - "description": "Historical state information.", - "id": "StateHistory", - "properties": { - "state": { - "description": "Output only. The state of the batch at this point in history.", - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "CANCELLING", - "CANCELLED", - "SUCCEEDED", - "FAILED" - ], - "enumDescriptions": [ - "The batch state is unknown.", - "The batch is created before running.", - "The batch is running.", - "The batch is cancelling.", - "The batch cancellation was successful.", - "The batch completed successfully.", - "The batch is no longer running due to an error." - ], - "readOnly": true, + }, + "speculative": { + "type": "boolean" + }, + "stageAttemptId": { + "format": "int32", + "type": "integer" + }, + "stageId": { + "format": "int64", "type": "string" }, - "stateMessage": { - "description": "Output only. Details about the state at this point in history.", - "readOnly": true, + "status": { "type": "string" }, - "stateStartTime": { - "description": "Output only. The time when the batch entered the historical state.", - "format": "google-datetime", - "readOnly": true, + "taskId": { + "format": "int64", "type": "string" + }, + "taskLocality": { + "type": "string" + }, + "taskMetrics": { + "$ref": "TaskMetrics" } }, "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", + "TaskMetrics": { + "description": "Executor Task Metrics", + "id": "TaskMetrics", "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" + "diskBytesSpilled": { + "format": "int64", + "type": "string" }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" + "executorCpuTimeNanos": { + "format": "int64", + "type": "string" }, - "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.", + "executorDeserializeCpuTimeNanos": { + "format": "int64", + "type": "string" + }, + "executorDeserializeTimeMillis": { + "format": "int64", + "type": "string" + }, + "executorRunTimeMillis": { + "format": "int64", + "type": "string" + }, + "inputMetrics": { + "$ref": "InputMetrics" + }, + "jvmGcTimeMillis": { + "format": "int64", + "type": "string" + }, + "memoryBytesSpilled": { + "format": "int64", + "type": "string" + }, + "outputMetrics": { + "$ref": "OutputMetrics" + }, + "peakExecutionMemoryBytes": { + "format": "int64", + "type": "string" + }, + "resultSerializationTimeMillis": { + "format": "int64", + "type": "string" + }, + "resultSize": { + "format": "int64", "type": "string" + }, + "shuffleReadMetrics": { + "$ref": "ShuffleReadMetrics" + }, + "shuffleWriteMetrics": { + "$ref": "ShuffleWriteMetrics" } }, "type": "object" }, - "StopClusterRequest": { - "description": "A request to stop a cluster.", - "id": "StopClusterRequest", + "TaskQuantileMetrics": { + "id": "TaskQuantileMetrics", "properties": { - "clusterUuid": { - "description": "Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist.", - "type": "string" + "diskBytesSpilled": { + "$ref": "Quantiles" }, - "requestId": { - "description": "Optional. A unique ID used to identify the request. If the server receives two StopClusterRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.StopClusterRequest)s with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", - "type": "string" + "durationMillis": { + "$ref": "Quantiles" + }, + "executorCpuTimeNanos": { + "$ref": "Quantiles" + }, + "executorDeserializeCpuTimeNanos": { + "$ref": "Quantiles" + }, + "executorDeserializeTimeMillis": { + "$ref": "Quantiles" + }, + "executorRunTimeMillis": { + "$ref": "Quantiles" + }, + "gettingResultTimeMillis": { + "$ref": "Quantiles" + }, + "inputMetrics": { + "$ref": "InputQuantileMetrics" + }, + "jvmGcTimeMillis": { + "$ref": "Quantiles" + }, + "memoryBytesSpilled": { + "$ref": "Quantiles" + }, + "outputMetrics": { + "$ref": "OutputQuantileMetrics" + }, + "peakExecutionMemoryBytes": { + "$ref": "Quantiles" + }, + "resultSerializationTimeMillis": { + "$ref": "Quantiles" + }, + "resultSize": { + "$ref": "Quantiles" + }, + "schedulerDelayMillis": { + "$ref": "Quantiles" + }, + "shuffleReadMetrics": { + "$ref": "ShuffleReadQuantileMetrics" + }, + "shuffleWriteMetrics": { + "$ref": "ShuffleWriteQuantileMetrics" } }, "type": "object" }, - "SubmitJobRequest": { - "description": "A request to submit a job.", - "id": "SubmitJobRequest", + "TaskResourceRequest": { + "description": "Resources used per task created by the application.", + "id": "TaskResourceRequest", "properties": { - "job": { - "$ref": "Job", - "description": "Required. The job resource." + "amount": { + "format": "double", + "type": "number" }, - "requestId": { - "description": "Optional. A unique id used to identify the request. If the server receives two SubmitJobRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.SubmitJobRequest)s with the same id, then the second request will be ignored and the first Job created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", + "resourceName": { "type": "string" } }, @@ -7548,6 +12670,53 @@ }, "type": "object" }, + "WriteSessionSparkApplicationContextRequest": { + "description": "Write Spark Application data to internal storage systems", + "id": "WriteSessionSparkApplicationContextRequest", + "properties": { + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "type": "string" + }, + "sparkWrapperObjects": { + "description": "Required. The batch of spark application context objects sent for ingestion.", + "items": { + "$ref": "SparkWrapperObject" + }, + "type": "array" + } + }, + "type": "object" + }, + "WriteSessionSparkApplicationContextResponse": { + "description": "Response returned as an acknowledgement of receipt of data.", + "id": "WriteSessionSparkApplicationContextResponse", + "properties": {}, + "type": "object" + }, + "WriteSparkApplicationContextRequest": { + "description": "Write Spark Application data to internal storage systems", + "id": "WriteSparkApplicationContextRequest", + "properties": { + "parent": { + "description": "Required. Parent (Batch) resource reference.", + "type": "string" + }, + "sparkWrapperObjects": { + "items": { + "$ref": "SparkWrapperObject" + }, + "type": "array" + } + }, + "type": "object" + }, + "WriteSparkApplicationContextResponse": { + "description": "Response returned as an acknowledgement of receipt of data.", + "id": "WriteSparkApplicationContextResponse", + "properties": {}, + "type": "object" + }, "YarnApplication": { "description": "A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", "id": "YarnApplication", diff --git a/discovery/datastream-v1.json b/discovery/datastream-v1.json index d81a01da7b..264fde6638 100644 --- a/discovery/datastream-v1.json +++ b/discovery/datastream-v1.json @@ -1250,7 +1250,7 @@ } } }, - "revision": "20240814", + "revision": "20240904", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -2778,6 +2778,10 @@ "cdcStrategy": { "$ref": "CdcStrategy", "description": "Optional. The CDC strategy of the stream. If not set, the system's default value will be used." + }, + "force": { + "description": "Optional. Update the stream without validating it.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 990516e29d..a0ebd2a6f7 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -20,6 +20,51 @@ "description": "Regional Endpoint", "endpointUrl": "https://developerconnect.us-central1.rep.googleapis.com/", "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.asia-east1.rep.googleapis.com/", + "location": "asia-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://developerconnect.us-west2.rep.googleapis.com/", + "location": "us-west2" } ], "fullyEncodeReservedExpansion": true, @@ -428,7 +473,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the Connection 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. Required. Field mask is used to specify the fields to be overwritten in the Connection 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" @@ -847,7 +892,7 @@ } } }, - "revision": "20240822", + "revision": "20240926", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -873,6 +918,10 @@ "readOnly": true, "type": "string" }, + "cryptoKeyConfig": { + "$ref": "CryptoKeyConfig", + "description": "Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature." + }, "deleteTime": { "description": "Output only. [Output only] Delete timestamp", "format": "google-datetime", @@ -891,6 +940,18 @@ "$ref": "GitHubConfig", "description": "Configuration for connections to github.com." }, + "githubEnterpriseConfig": { + "$ref": "GitHubEnterpriseConfig", + "description": "Configuration for connections to an instance of GitHub Enterprise." + }, + "gitlabConfig": { + "$ref": "GitLabConfig", + "description": "Configuration for connections to gitlab.com." + }, + "gitlabEnterpriseConfig": { + "$ref": "GitLabEnterpriseConfig", + "description": "Configuration for connections to an instance of GitLab Enterprise." + }, "installationState": { "$ref": "InstallationState", "description": "Output only. Installation state of the Connection.", @@ -926,6 +987,17 @@ }, "type": "object" }, + "CryptoKeyConfig": { + "description": "The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.", + "id": "CryptoKeyConfig", + "properties": { + "keyReference": { + "description": "Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "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", @@ -1069,6 +1141,113 @@ }, "type": "object" }, + "GitHubEnterpriseConfig": { + "description": "Configuration for connections to an instance of GitHub Enterprise.", + "id": "GitHubEnterpriseConfig", + "properties": { + "appId": { + "description": "Optional. ID of the GitHub App created from the manifest.", + "format": "int64", + "type": "string" + }, + "appInstallationId": { + "description": "Optional. ID of the installation of the GitHub App.", + "format": "int64", + "type": "string" + }, + "appSlug": { + "description": "Output only. The URL-friendly name of the GitHub App.", + "readOnly": true, + "type": "string" + }, + "hostUri": { + "description": "Required. The URI of the GitHub Enterprise host this connection is for.", + "type": "string" + }, + "installationUri": { + "description": "Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig.", + "readOnly": true, + "type": "string" + }, + "privateKeySecretVersion": { + "description": "Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "type": "string" + }, + "serverVersion": { + "description": "Output only. GitHub Enterprise version installed at the host_uri.", + "readOnly": true, + "type": "string" + }, + "serviceDirectoryConfig": { + "$ref": "ServiceDirectoryConfig", + "description": "Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet." + }, + "sslCaCertificate": { + "description": "Optional. SSL certificate to use for requests to GitHub Enterprise.", + "type": "string" + }, + "webhookSecretSecretVersion": { + "description": "Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "type": "string" + } + }, + "type": "object" + }, + "GitLabConfig": { + "description": "Configuration for connections to gitlab.com.", + "id": "GitLabConfig", + "properties": { + "authorizerCredential": { + "$ref": "UserCredential", + "description": "Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to." + }, + "readAuthorizerCredential": { + "$ref": "UserCredential", + "description": "Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to." + }, + "webhookSecretSecretVersion": { + "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "type": "string" + } + }, + "type": "object" + }, + "GitLabEnterpriseConfig": { + "description": "Configuration for connections to an instance of GitLab Enterprise.", + "id": "GitLabEnterpriseConfig", + "properties": { + "authorizerCredential": { + "$ref": "UserCredential", + "description": "Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to." + }, + "hostUri": { + "description": "Required. The URI of the GitLab Enterprise host this connection is for.", + "type": "string" + }, + "readAuthorizerCredential": { + "$ref": "UserCredential", + "description": "Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to." + }, + "serverVersion": { + "description": "Output only. Version of the GitLab Enterprise server running on the `host_uri`.", + "readOnly": true, + "type": "string" + }, + "serviceDirectoryConfig": { + "$ref": "ServiceDirectoryConfig", + "description": "Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet." + }, + "sslCaCertificate": { + "description": "Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance.", + "type": "string" + }, + "webhookSecretSecretVersion": { + "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "type": "string" + } + }, + "type": "object" + }, "GitRepositoryLink": { "description": "Message describing the GitRepositoryLink object", "id": "GitRepositoryLink", @@ -1126,6 +1305,11 @@ "format": "google-datetime", "readOnly": true, "type": "string" + }, + "webhookId": { + "description": "Output only. External ID of the webhook created for the repository.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -1412,6 +1596,17 @@ }, "type": "object" }, + "ServiceDirectoryConfig": { + "description": "ServiceDirectoryConfig represents Service Directory configuration for a connection.", + "id": "ServiceDirectoryConfig", + "properties": { + "service": { + "description": "Required. The Service Directory service name. Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.", + "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", @@ -1438,6 +1633,22 @@ } }, "type": "object" + }, + "UserCredential": { + "description": "Represents a personal access token that authorized the Connection, and associated metadata.", + "id": "UserCredential", + "properties": { + "userTokenSecretVersion": { + "description": "Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.", + "type": "string" + }, + "username": { + "description": "Output only. The username associated with this token.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index 33d996b8dd..ec0a3d3502 100644 --- a/discovery/dfareporting-v4.json +++ b/discovery/dfareporting-v4.json @@ -9561,6 +9561,91 @@ } } }, + "tvCampaignDetails": { + "methods": { + "get": { + "description": "Gets one TvCampaignDetail by ID.", + "flatPath": "userprofiles/{userprofilesId}/tvCampaignDetails/{tvCampaignDetailsId}", + "httpMethod": "GET", + "id": "dfareporting.tvCampaignDetails.get", + "parameterOrder": [ + "profileId", + "id" + ], + "parameters": { + "accountId": { + "description": "Required. Account ID associated with this request.", + "format": "int64", + "location": "query", + "type": "string" + }, + "id": { + "description": "Required. TV Campaign ID.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "profileId": { + "description": "Required. User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/tvCampaignDetails/{+id}", + "response": { + "$ref": "TvCampaignDetail" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, + "tvCampaignSummaries": { + "methods": { + "list": { + "description": "Retrieves a list of TV campaign summaries.", + "flatPath": "userprofiles/{userprofilesId}/tvCampaignSummaries", + "httpMethod": "GET", + "id": "dfareporting.tvCampaignSummaries.list", + "parameterOrder": [ + "profileId" + ], + "parameters": { + "accountId": { + "description": "Required. Account ID associated with this request.", + "format": "int64", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.", + "location": "query", + "type": "string" + }, + "profileId": { + "description": "Required. User profile ID associated with this request.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "userprofiles/{+profileId}/tvCampaignSummaries", + "response": { + "$ref": "TvCampaignSummariesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/dfatrafficking" + ] + } + } + }, "userProfiles": { "methods": { "get": { @@ -10067,7 +10152,7 @@ } } }, - "revision": "20240821", + "revision": "20240926", "rootUrl": "https://dfareporting.googleapis.com/", "schemas": { "Account": { @@ -11664,7 +11749,7 @@ "type": "object" }, "CartData": { - "description": "Contains additional information about cart data.", + "description": "Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate.", "id": "CartData", "properties": { "items": { @@ -11683,7 +11768,7 @@ "type": "string" }, "merchantId": { - "description": "The Merchant Center ID where the items are uploaded.", + "description": "The Merchant Center ID where the items are uploaded. This is a required field.", "format": "int64", "type": "string" } @@ -11968,13 +12053,17 @@ "type": "object" }, "CompatibleFields": { - "description": "Represents a response to the queryCompatibleFields method.", + "description": "Represents a response to the queryCompatibleFields method. Next ID: 10", "id": "CompatibleFields", "properties": { "crossDimensionReachReportCompatibleFields": { "$ref": "CrossDimensionReachReportCompatibleFields", "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"." }, + "crossMediaReachReportCompatibleFields": { + "$ref": "CrossMediaReachReportCompatibleFields", + "description": "Contains items that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\"." + }, "floodlightReportCompatibleFields": { "$ref": "FloodlightReportCompatibleFields", "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"." @@ -12107,7 +12196,7 @@ "type": "boolean" }, "customVariables": { - "description": "Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.", + "description": "Custom floodlight variables.", "items": { "$ref": "CustomFloodlightVariable" }, @@ -14300,6 +14389,38 @@ }, "type": "object" }, + "CrossMediaReachReportCompatibleFields": { + "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\".", + "id": "CrossMediaReachReportCompatibleFields", + "properties": { + "dimensionFilters": { + "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "dimensions": { + "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.", + "items": { + "$ref": "Dimension" + }, + "type": "array" + }, + "kind": { + "description": "The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields.", + "type": "string" + }, + "metrics": { + "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.", + "items": { + "$ref": "Metric" + }, + "type": "array" + } + }, + "type": "object" + }, "CustomFloodlightVariable": { "description": "A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.", "id": "CustomFloodlightVariable", @@ -14309,7 +14430,7 @@ "type": "string" }, "type": { - "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.", + "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-100]=\" in the tags.", "enum": [ "U1", "U2", @@ -19117,6 +19238,37 @@ }, "type": "object" }, + "crossMediaReachCriteria": { + "description": "Optional. The report criteria for a report of type \"CROSS_MEDIA_REACH\".", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "Required. The date range this report should be run for." + }, + "dimensionFilters": { + "description": "Required. The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.", + "items": { + "$ref": "DimensionValue" + }, + "type": "array" + }, + "dimensions": { + "description": "Required. The list of dimensions the report should include.", + "items": { + "$ref": "SortedDimension" + }, + "type": "array" + }, + "metricNames": { + "description": "Required. The list of names of metrics the report should include.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "delivery": { "description": "The report's email delivery settings.", "properties": { @@ -19486,13 +19638,15 @@ "REACH", "PATH_TO_CONVERSION", "CROSS_DIMENSION_REACH", - "FLOODLIGHT" + "FLOODLIGHT", + "CROSS_MEDIA_REACH" ], "enumDescriptions": [ "", "", "", "", + "", "" ], "type": "string" @@ -20561,6 +20715,140 @@ }, "type": "object" }, + "TvCampaignDetail": { + "description": "TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.", + "id": "TvCampaignDetail", + "properties": { + "id": { + "description": "ID of this TV campaign.", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".", + "type": "string" + }, + "timepoints": { + "description": "The timepoints of the TV campaign.", + "items": { + "$ref": "TvCampaignTimepoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "TvCampaignSummariesListResponse": { + "description": "Response message for TvCampaignSummariesService.List.", + "id": "TvCampaignSummariesListResponse", + "properties": { + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummariesListResponse\".", + "type": "string" + }, + "tvCampaignSummaries": { + "description": "List of TV campaign summaries.", + "items": { + "$ref": "TvCampaignSummary" + }, + "type": "array" + } + }, + "type": "object" + }, + "TvCampaignSummary": { + "description": "TvCampaignSummary contains aggregate data from a TV campaign.", + "id": "TvCampaignSummary", + "properties": { + "endDate": { + "description": "The end date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".", + "type": "string" + }, + "grp": { + "description": "GRP of this TV campaign.", + "format": "int64", + "type": "string" + }, + "id": { + "description": "ID of this TV campaign.", + "type": "string" + }, + "impressions": { + "description": "Impressions across the entire TV campaign.", + "format": "int64", + "type": "string" + }, + "kind": { + "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".", + "type": "string" + }, + "name": { + "description": "Identifier. Name of this TV campaign.", + "type": "string" + }, + "spend": { + "description": "Spend across the entire TV campaign.", + "format": "double", + "type": "number" + }, + "startDate": { + "description": "The start date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".", + "type": "string" + }, + "type": { + "description": "\"CampaignComponentType\" of this TV campaign.", + "enum": [ + "CAMPAIGN_COMPONENT_TYPE_UNSPECIFIED", + "COMPANY", + "BRAND", + "PRODUCT", + "CAMPAIGN" + ], + "enumDescriptions": [ + "Required to exist; do not use.", + "Company.", + "Brand.", + "Product.", + "Campaign." + ], + "type": "string" + } + }, + "type": "object" + }, + "TvCampaignTimepoint": { + "description": "A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.", + "id": "TvCampaignTimepoint", + "properties": { + "dateWindow": { + "description": "The date window of the timepoint.", + "enum": [ + "WEEKS_UNSPECIFIED", + "WEEKS_ONE", + "WEEKS_FOUR", + "WEEKS_EIGHT", + "WEEKS_TWELVE" + ], + "enumDescriptions": [ + "Default value, should never be set.", + "One week.", + "Four weeks.", + "Eight weeks.", + "Twelve weeks." + ], + "type": "string" + }, + "spend": { + "description": "The spend within the time range of the timepoint.", + "format": "double", + "type": "number" + }, + "startDate": { + "description": "The start date of the timepoint. A string in the format of \"yyyy-MM-dd\".", + "type": "string" + } + }, + "type": "object" + }, "UniversalAdId": { "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.", "id": "UniversalAdId", diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 1d1c6a2393..4339f0185c 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8714,7 +8714,7 @@ } } }, - "revision": "20240828", + "revision": "20240924", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9678,7 +9678,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -9688,7 +9689,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -11983,7 +11985,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -11993,7 +11996,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -14330,6 +14334,16 @@ "description": "Output only. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/`", "readOnly": true, "type": "string" + }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the dataset.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the dataset.", + "readOnly": true, + "type": "boolean" } }, "type": "object" @@ -14417,6 +14431,16 @@ "description": "ConversationModel resource name. Format: `projects//conversationModels/`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the model.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the model.", + "readOnly": true, + "type": "boolean" + }, "smartReplyModelMetadata": { "$ref": "GoogleCloudDialogflowV2SmartReplyModelMetadata", "description": "Metadata for smart reply models." @@ -16158,7 +16182,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -16168,7 +16193,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -17862,7 +17888,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -17870,7 +17897,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -18518,7 +18546,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -18528,7 +18557,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -19049,7 +19079,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -19057,7 +19088,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index e10f8bfae0..b54cbfe9c1 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -8082,7 +8082,7 @@ } } }, - "revision": "20240828", + "revision": "20240924", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9046,7 +9046,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -9056,7 +9057,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -11351,7 +11353,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -11361,7 +11364,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -13002,6 +13006,16 @@ "description": "ConversationModel resource name. Format: `projects//conversationModels/`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the model.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the model.", + "readOnly": true, + "type": "boolean" + }, "smartReplyModelMetadata": { "$ref": "GoogleCloudDialogflowV2SmartReplyModelMetadata", "description": "Metadata for smart reply models." @@ -17585,7 +17599,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -17595,7 +17610,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -19614,7 +19630,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -19622,7 +19639,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -20345,7 +20363,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -20355,7 +20374,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -21096,7 +21116,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -21104,7 +21125,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 27157b5694..d68c89f19f 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240828", + "revision": "20240924", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -7250,7 +7250,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -7260,7 +7261,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -7989,7 +7991,7 @@ "id": "GoogleCloudDialogflowCxV3NluSettings", "properties": { "classificationThreshold": { - "description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", + "description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent.", "format": "float", "type": "number" }, @@ -8036,7 +8038,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -8044,7 +8047,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -8337,7 +8341,7 @@ }, "dataStoreConnectionSignals": { "$ref": "GoogleCloudDialogflowCxV3DataStoreConnectionSignals", - "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request." + "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request." }, "diagnosticInfo": { "additionalProperties": { @@ -11180,7 +11184,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -11190,7 +11195,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -12831,6 +12837,16 @@ "description": "ConversationModel resource name. Format: `projects//conversationModels/`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the model.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the model.", + "readOnly": true, + "type": "boolean" + }, "smartReplyModelMetadata": { "$ref": "GoogleCloudDialogflowV2SmartReplyModelMetadata", "description": "Metadata for smart reply models." diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index ccc44f0314..a5ef22d6fc 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -3381,7 +3381,7 @@ ], "parameters": { "languageCode": { - "description": "Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used.", + "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" }, @@ -5185,7 +5185,7 @@ } } }, - "revision": "20240828", + "revision": "20240924", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -6149,7 +6149,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -6159,7 +6160,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -7636,6 +7638,10 @@ "description": "The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration.", "type": "string" }, + "bigqueryExportSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1BigQueryExportSettings", + "description": "Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set include_bigquery_export_settings to include it in the exported agent." + }, "clientCertificateSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1AgentClientCertificateSettings", "description": "Optional. Settings for custom client certificates." @@ -7985,6 +7991,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1BigQueryExportSettings": { + "description": "The settings of BigQuery export.", + "id": "GoogleCloudDialogflowCxV3beta1BigQueryExportSettings", + "properties": { + "bigqueryTable": { + "description": "The BigQuery table to export. Format: `projects//datasets//tables/`.", + "type": "string" + }, + "enabled": { + "description": "The field to indicate whether the BigQuery export is enabled.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1BoostSpec": { "description": "Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec", "id": "GoogleCloudDialogflowCxV3beta1BoostSpec", @@ -9317,7 +9338,7 @@ "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.", + "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": { @@ -10809,7 +10830,8 @@ "AUDIO_ENCODING_AMR", "AUDIO_ENCODING_AMR_WB", "AUDIO_ENCODING_OGG_OPUS", - "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE", + "AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -10819,7 +10841,8 @@ "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", - "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -11653,7 +11676,7 @@ "id": "GoogleCloudDialogflowCxV3beta1NluSettings", "properties": { "classificationThreshold": { - "description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used.", + "description": "To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent.", "format": "float", "type": "number" }, @@ -11700,7 +11723,8 @@ "OUTPUT_AUDIO_ENCODING_MP3", "OUTPUT_AUDIO_ENCODING_MP3_64_KBPS", "OUTPUT_AUDIO_ENCODING_OGG_OPUS", - "OUTPUT_AUDIO_ENCODING_MULAW" + "OUTPUT_AUDIO_ENCODING_MULAW", + "OUTPUT_AUDIO_ENCODING_ALAW" ], "enumDescriptions": [ "Not specified.", @@ -11708,7 +11732,8 @@ "MP3 audio at 32kbps.", "MP3 audio at 64kbps.", "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law." + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, @@ -12284,7 +12309,7 @@ }, "dataStoreConnectionSignals": { "$ref": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals", - "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request." + "description": "Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request." }, "diagnosticInfo": { "additionalProperties": { @@ -12803,6 +12828,20 @@ "$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsPhrase" }, "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" @@ -13461,6 +13500,13 @@ ], "type": "string" }, + "scopes": { + "description": "Optional. The OAuth scopes to grant.", + "items": { + "type": "string" + }, + "type": "array" + }, "tokenEndpoint": { "description": "Required. The token endpoint in the OAuth provider to exchange for an access token.", "type": "string" @@ -14861,6 +14907,16 @@ "description": "ConversationModel resource name. Format: `projects//conversationModels/`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. A read only boolean field reflecting Zone Isolation status of the model.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. A read only boolean field reflecting Zone Separation status of the model.", + "readOnly": true, + "type": "boolean" + }, "smartReplyModelMetadata": { "$ref": "GoogleCloudDialogflowV2SmartReplyModelMetadata", "description": "Metadata for smart reply models." diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 54419054d6..e6579b9111 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -14,7 +14,7 @@ "canonicalName": "Discovery Engine", "description": "Discovery Engine API.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -921,7 +921,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -949,7 +949,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -974,7 +974,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -1015,7 +1015,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1078,7 +1078,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1106,7 +1106,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1134,7 +1134,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1159,7 +1159,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1205,7 +1205,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1757,7 +1757,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1785,7 +1785,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -1810,7 +1810,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -1856,7 +1856,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1919,7 +1919,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -2549,7 +2549,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2740,7 +2740,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. 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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2783,7 +2783,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2811,7 +2811,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -2836,7 +2836,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -2877,7 +2877,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2940,7 +2940,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -2968,7 +2968,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2996,7 +2996,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3021,7 +3021,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3067,7 +3067,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3288,7 +3288,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3316,7 +3316,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -3341,7 +3341,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -3387,7 +3387,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3450,7 +3450,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -4221,7 +4221,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4249,7 +4249,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -4274,7 +4274,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -4315,7 +4315,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4378,7 +4378,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4406,7 +4406,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4434,7 +4434,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4459,7 +4459,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4505,7 +4505,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4956,7 +4956,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4984,7 +4984,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5009,7 +5009,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5055,7 +5055,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5118,7 +5118,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -5542,7 +5542,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5629,15 +5629,15 @@ } } }, - "identity_mapping_stores": { + "identityMappingStores": { "resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", "parameterOrder": [ "name" ], @@ -5645,7 +5645,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -5660,9 +5660,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations", "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.list", "parameterOrder": [ "name" ], @@ -5675,7 +5675,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "required": true, "type": "string" }, @@ -5785,7 +5785,7 @@ ], "parameters": { "rankingConfig": { - "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.", + "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$", "required": true, @@ -5986,7 +5986,7 @@ } } }, - "revision": "20240826", + "revision": "20240930", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6181,17 +6181,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The 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." ], "type": "string" }, @@ -6312,7 +6314,8 @@ "description": "Answer generation specification." }, "asynchronousMode": { - "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", + "deprecated": true, + "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, "query": { @@ -6365,6 +6368,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", "type": "boolean" @@ -6436,13 +6443,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -6589,6 +6598,25 @@ "content": { "description": "Chunk textual content.", "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Uri of the document.", + "type": "string" } }, "type": "object" @@ -6602,14 +6630,15 @@ "type": "string" }, "documentContexts": { - "description": "List of document contexts.", + "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, "type": "array" }, "extractiveAnswers": { - "description": "List of extractive answers.", + "deprecated": true, + "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.", "items": { "$ref": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" }, @@ -6638,7 +6667,7 @@ "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { "content": { - "description": "Document content.", + "description": "Document content to be used for answer generation.", "type": "string" }, "pageIdentifier": { @@ -6664,7 +6693,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", "id": "GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "properties": { "content": { @@ -6725,13 +6754,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -6978,7 +7009,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", "type": "object" }, "title": { @@ -7114,13 +7145,13 @@ "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document." }, - "status": { - "description": "The status of the document.", + "state": { + "description": "The state of the document.", "enum": [ - "STATUS_UNSPECIFIED", - "STATUS_INDEXED", - "STATUS_NOT_IN_TARGET_SITE", - "STATUS_NOT_IN_INDEX" + "STATE_UNSPECIFIED", + "INDEXED", + "NOT_IN_TARGET_SITE", + "NOT_IN_INDEX" ], "enumDescriptions": [ "Should never be set.", @@ -7974,7 +8005,7 @@ "type": "boolean" }, "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", + "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, "summarySpec": { @@ -8132,6 +8163,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -8170,7 +8205,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -8185,6 +8220,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -8242,6 +8282,10 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -8274,6 +8318,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -8392,6 +8473,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, + "indexStatus": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentIndexStatus", + "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", + "readOnly": true + }, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -8445,6 +8531,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DocumentIndexStatus": { + "description": "Index status of the document.", + "id": "GoogleCloudDiscoveryengineV1DocumentIndexStatus", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "indexTime": { + "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1DocumentInfo", @@ -8459,7 +8564,7 @@ "type": "boolean" }, "name": { - "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "description": "The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, "promotionIds": { @@ -8501,7 +8606,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -8643,6 +8748,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -8664,7 +8773,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -9584,7 +9693,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -10052,6 +10161,10 @@ "description": "Request message for SiteSearchEngineService.RecrawlUris method.", "id": "GoogleCloudDiscoveryengineV1RecrawlUrisRequest", "properties": { + "siteCredential": { + "description": "Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", + "type": "string" + }, "uris": { "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", "items": { @@ -10256,6 +10369,10 @@ "format": "float", "type": "number" }, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, "condition": { "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" @@ -10263,6 +10380,66 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "properties": { + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "enumDescriptions": [ + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." + ], + "type": "string" + }, + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec": { "description": "A specification for configuring the behavior of content search.", "id": "GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec", @@ -10378,6 +10555,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -10443,6 +10624,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -10781,18 +10966,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -10944,6 +11131,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Session": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1Session", @@ -11502,6 +11700,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -11510,15 +11716,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -11555,17 +11765,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The 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." ], "type": "string" }, @@ -11705,13 +11917,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -11958,7 +12172,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", "type": "object" }, "title": { @@ -12342,6 +12556,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -12380,7 +12598,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -12399,6 +12617,11 @@ "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" }, + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -12465,6 +12688,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -12497,6 +12728,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -12608,7 +12876,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -12744,6 +13012,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -12769,7 +13041,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "recommendationMetadata": { @@ -13233,6 +13505,10 @@ "readOnly": true, "type": "string" }, + "metatagName": { + "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", + "type": "string" + }, "recsFilterableOption": { "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", "enum": [ @@ -13658,6 +13934,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -13669,7 +13966,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -14189,6 +14486,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -14474,6 +14775,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -14539,6 +14844,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -14689,6 +14998,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", @@ -14772,6 +15102,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSession": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1alphaSession", @@ -15042,7 +15383,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -15111,6 +15452,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -15119,15 +15468,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -15447,6 +15800,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -15485,7 +15842,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -15500,6 +15857,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -15561,6 +15923,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -15593,6 +15963,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -15704,7 +16111,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -15840,6 +16247,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -15861,7 +16272,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -16400,6 +16811,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -16411,7 +16843,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -16722,6 +17154,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -17007,6 +17443,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -17072,6 +17512,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -17222,6 +17666,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", @@ -17305,6 +17770,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", @@ -17491,7 +17967,7 @@ "id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -17560,6 +18036,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -17568,15 +18052,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index e4c5be1417..1e19dee149 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -14,7 +14,7 @@ "canonicalName": "Discovery Engine", "description": "Discovery Engine API.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -501,7 +501,7 @@ ], "parameters": { "name": { - "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", + "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "required": true, @@ -1238,7 +1238,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1266,7 +1266,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -1291,7 +1291,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -1332,7 +1332,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1395,7 +1395,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1423,7 +1423,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1451,7 +1451,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1476,7 +1476,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1522,7 +1522,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2014,7 +2014,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -2050,7 +2050,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2169,7 +2169,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2197,7 +2197,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -2222,7 +2222,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -2268,7 +2268,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2331,7 +2331,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -3014,7 +3014,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -3205,7 +3205,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. 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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3239,7 +3239,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3267,7 +3267,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3295,7 +3295,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3332,7 +3332,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3360,7 +3360,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -3385,7 +3385,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -3426,7 +3426,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3489,7 +3489,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3517,7 +3517,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3545,7 +3545,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3570,7 +3570,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3616,7 +3616,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3777,7 +3777,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3813,7 +3813,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3932,7 +3932,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3960,7 +3960,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -3985,7 +3985,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -4031,7 +4031,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -4094,7 +4094,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -4337,7 +4337,7 @@ ], "parameters": { "name": { - "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", + "description": "Required. Full DocumentProcessingConfig resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/documentProcessingConfig$", "required": true, @@ -5046,7 +5046,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5074,7 +5074,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -5099,7 +5099,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -5140,7 +5140,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5203,7 +5203,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -5231,7 +5231,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5259,7 +5259,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -5284,7 +5284,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -5330,7 +5330,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5721,7 +5721,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -5757,7 +5757,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5876,7 +5876,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5904,7 +5904,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5929,7 +5929,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5975,7 +5975,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6038,7 +6038,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -6462,7 +6462,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6709,15 +6709,15 @@ } } }, - "identity_mapping_stores": { + "identityMappingStores": { "resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", "parameterOrder": [ "name" ], @@ -6725,7 +6725,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6740,9 +6740,9 @@ }, "list": { "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations", "httpMethod": "GET", - "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.list", "parameterOrder": [ "name" ], @@ -6755,7 +6755,7 @@ "name": { "description": "The name of the operation's parent resource.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", "required": true, "type": "string" }, @@ -6865,7 +6865,7 @@ ], "parameters": { "rankingConfig": { - "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.", + "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$", "required": true, @@ -7517,7 +7517,7 @@ } } }, - "revision": "20240826", + "revision": "20240930", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -8149,6 +8149,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -8206,6 +8211,10 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -8238,6 +8247,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -8349,7 +8395,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -8485,6 +8531,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -8506,7 +8556,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -8849,7 +8899,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -9062,6 +9112,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", @@ -9285,6 +9346,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -9293,15 +9362,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -9369,17 +9442,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The 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." ], "type": "string" }, @@ -9500,7 +9575,8 @@ "description": "Answer generation specification." }, "asynchronousMode": { - "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", + "deprecated": true, + "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, "query": { @@ -9553,6 +9629,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", "type": "boolean" @@ -9624,13 +9704,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -9720,6 +9802,10 @@ "format": "int32", "type": "integer" }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "Optional. Specification to enable natural language understanding capabilities for search requests." + }, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -9781,6 +9867,25 @@ "content": { "description": "Chunk textual content.", "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Uri of the document.", + "type": "string" } }, "type": "object" @@ -9794,14 +9899,15 @@ "type": "string" }, "documentContexts": { - "description": "List of document contexts.", + "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, "type": "array" }, "extractiveAnswers": { - "description": "List of extractive answers.", + "deprecated": true, + "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" }, @@ -9830,7 +9936,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { "content": { - "description": "Document content.", + "description": "Document content to be used for answer generation.", "type": "string" }, "pageIdentifier": { @@ -9856,7 +9962,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "properties": { "content": { @@ -9917,13 +10023,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -10170,7 +10278,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", "type": "object" }, "title": { @@ -10306,13 +10414,13 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document." }, - "status": { - "description": "The status of the document.", + "state": { + "description": "The state of the document.", "enum": [ - "STATUS_UNSPECIFIED", - "STATUS_INDEXED", - "STATUS_NOT_IN_TARGET_SITE", - "STATUS_NOT_IN_INDEX" + "STATE_UNSPECIFIED", + "INDEXED", + "NOT_IN_TARGET_SITE", + "NOT_IN_INDEX" ], "enumDescriptions": [ "Should never be set.", @@ -11255,7 +11363,7 @@ "type": "boolean" }, "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", + "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, "summarySpec": { @@ -11437,6 +11545,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -11475,7 +11587,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -11494,6 +11606,11 @@ "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" }, + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -11560,6 +11677,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -11592,6 +11717,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -11714,6 +11876,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, + "indexStatus": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", + "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", + "readOnly": true + }, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -11799,6 +11966,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus": { + "description": "Index status of the document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "indexTime": { + "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", @@ -11813,7 +11999,7 @@ "type": "boolean" }, "name": { - "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "description": "The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, "promotionIds": { @@ -11855,7 +12041,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -12023,6 +12209,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -12048,7 +12238,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "recommendationMetadata": { @@ -12647,6 +12837,10 @@ "readOnly": true, "type": "string" }, + "metatagName": { + "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", + "type": "string" + }, "recsFilterableOption": { "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", "enum": [ @@ -13670,6 +13864,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", @@ -13765,7 +13980,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -14370,6 +14585,10 @@ "description": "Request message for SiteSearchEngineService.RecrawlUris method.", "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", "properties": { + "siteCredential": { + "description": "Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", + "type": "string" + }, "uris": { "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", "items": { @@ -14864,6 +15083,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -15149,6 +15372,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -15214,6 +15441,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -15364,6 +15595,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", @@ -15809,13 +16061,15 @@ "ONE_BOX_TYPE_UNSPECIFIED", "PEOPLE", "ORGANIZATION", - "SLACK" + "SLACK", + "KNOWLEDGE_GRAPH" ], "enumDescriptions": [ "Default value. Should not be used.", "One Box result contains people results.", "One Box result contains organization results.", - "One Box result contains slack results." + "One Box result contains slack results.", + "One Box result contains Knowledge Graph search responses." ], "type": "string" }, @@ -15906,18 +16160,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -16150,6 +16406,10 @@ }, "type": "array" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "rankingExpression": { "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" @@ -16202,6 +16462,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", @@ -16698,7 +16969,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -16873,6 +17144,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -16881,15 +17160,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -17209,6 +17492,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -17247,7 +17534,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -17262,6 +17549,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -17323,6 +17615,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -17355,6 +17655,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -17466,7 +17803,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -17602,6 +17939,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -17623,7 +17964,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -18162,6 +18503,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1betaProject", @@ -18173,7 +18535,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -18484,6 +18846,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -18769,6 +19135,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -18834,6 +19204,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -18984,6 +19358,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", @@ -19067,6 +19462,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1betaSiteVerificationInfo", @@ -19253,7 +19659,7 @@ "id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -19322,6 +19728,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -19330,15 +19744,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index e8ac6aeac4..304df5016c 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -14,7 +14,7 @@ "canonicalName": "Discovery Engine", "description": "Discovery Engine API.", "discoveryVersion": "v1", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/docs/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -921,7 +921,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -949,7 +949,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -974,7 +974,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -1015,7 +1015,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1078,7 +1078,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1106,7 +1106,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1134,7 +1134,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1159,7 +1159,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -1205,7 +1205,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1697,7 +1697,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -1733,7 +1733,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1852,7 +1852,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -1880,7 +1880,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -1905,7 +1905,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -1951,7 +1951,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2014,7 +2014,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -2644,7 +2644,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", "required": true, @@ -2835,7 +2835,7 @@ ], "parameters": { "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. 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.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2869,7 +2869,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the engine to pause. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The name of the engine to pause. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2897,7 +2897,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the engine to resume. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The name of the engine to resume. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2925,7 +2925,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the engine to tune. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine to tune. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2962,7 +2962,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -2990,7 +2990,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -3015,7 +3015,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/controls/[^/]+$", "required": true, @@ -3056,7 +3056,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3119,7 +3119,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3147,7 +3147,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3175,7 +3175,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3200,7 +3200,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/conversations/[^/]+$", "required": true, @@ -3246,7 +3246,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3407,7 +3407,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -3443,7 +3443,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3562,7 +3562,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3590,7 +3590,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -3615,7 +3615,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+$", "required": true, @@ -3661,7 +3661,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+$", "required": true, @@ -3724,7 +3724,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -4495,7 +4495,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4523,7 +4523,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -4548,7 +4548,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Control to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", + "description": "Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/controls/[^/]+$", "required": true, @@ -4589,7 +4589,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4652,7 +4652,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4680,7 +4680,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -4708,7 +4708,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4733,7 +4733,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", + "description": "Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/conversations/[^/]+$", "required": true, @@ -4779,7 +4779,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5170,7 +5170,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", + "description": "Required. The resource name of the ServingConfig to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$", "required": true, @@ -5206,7 +5206,7 @@ "type": "string" }, "parent": { - "description": "Required. Full resource name of the parent resource. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`", + "description": "Required. Full resource name of the parent resource. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5325,7 +5325,7 @@ ], "parameters": { "parent": { - "description": "Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5353,7 +5353,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to delete. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5378,7 +5378,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", + "description": "Required. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+$", "required": true, @@ -5424,7 +5424,7 @@ "type": "string" }, "parent": { - "description": "Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`", + "description": "Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -5487,7 +5487,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", + "description": "Required. The resource name of the Answer to get. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/sessions/[^/]+/answers/[^/]+$", "required": true, @@ -5911,7 +5911,7 @@ ], "parameters": { "parent": { - "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", "required": true, @@ -6158,6 +6158,80 @@ } } }, + "identityMappingStores": { + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/identityMappingStores/{identityMappingStoresId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identityMappingStores.operations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -6240,7 +6314,7 @@ ], "parameters": { "rankingConfig": { - "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.", + "description": "Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/rankingConfigs/[^/]+$", "required": true, @@ -6786,7 +6860,7 @@ } } }, - "revision": "20240826", + "revision": "20240930", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -7232,6 +7306,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -7289,6 +7368,10 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -7321,6 +7404,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1DataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", @@ -7432,7 +7552,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -7568,6 +7688,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -7589,7 +7713,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -7932,7 +8056,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -8145,6 +8269,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1ServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", @@ -8368,6 +8503,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -8376,15 +8519,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -8421,17 +8568,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The 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." ], "type": "string" }, @@ -8571,13 +8720,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -8824,7 +8975,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", "type": "object" }, "title": { @@ -9208,6 +9359,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -9246,7 +9401,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -9265,6 +9420,11 @@ "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" }, + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -9331,6 +9491,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -9363,6 +9531,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", @@ -9474,7 +9679,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -9610,6 +9815,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -9635,7 +9844,7 @@ "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "recommendationMetadata": { @@ -10099,6 +10308,10 @@ "readOnly": true, "type": "string" }, + "metatagName": { + "description": "Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.", + "type": "string" + }, "recsFilterableOption": { "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", "enum": [ @@ -10524,6 +10737,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", @@ -10535,7 +10769,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -11055,6 +11289,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -11340,6 +11578,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -11405,6 +11647,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -11555,6 +11801,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", @@ -11638,6 +11905,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSession": { "description": "External session proto definition.", "id": "GoogleCloudDiscoveryengineV1alphaSession", @@ -11908,7 +12186,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -11977,6 +12255,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -11985,15 +12271,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } @@ -12046,17 +12336,19 @@ "POTENTIAL_POLICY_VIOLATION", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_ANSWER_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", + "The non-answer seeking query ignored case Google skips the answer if the query is chit chat.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The 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." ], "type": "string" }, @@ -12177,7 +12469,8 @@ "description": "Answer generation specification." }, "asynchronousMode": { - "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", + "deprecated": true, + "description": "Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", "type": "boolean" }, "query": { @@ -12230,6 +12523,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", "type": "boolean" @@ -12301,13 +12598,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" }, @@ -12393,6 +12692,10 @@ "format": "int32", "type": "integer" }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "Optional. Specification to enable natural language understanding capabilities for search requests." + }, "orderBy": { "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" @@ -12454,6 +12757,25 @@ "content": { "description": "Chunk textual content.", "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "description": "Metadata of the document from the current chunk." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata", + "properties": { + "title": { + "description": "Title of the document.", + "type": "string" + }, + "uri": { + "description": "Uri of the document.", + "type": "string" } }, "type": "object" @@ -12467,14 +12789,15 @@ "type": "string" }, "documentContexts": { - "description": "List of document contexts.", + "description": "List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" }, "type": "array" }, "extractiveAnswers": { - "description": "List of extractive answers.", + "deprecated": true, + "description": "Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" }, @@ -12503,7 +12826,7 @@ "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { "content": { - "description": "Document content.", + "description": "Document content to be used for answer generation.", "type": "string" }, "pageIdentifier": { @@ -12529,7 +12852,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets.", "id": "GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "properties": { "content": { @@ -12590,13 +12913,15 @@ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", "NON_ANSWER_SEEKING_QUERY", - "JAIL_BREAKING_QUERY" + "JAIL_BREAKING_QUERY", + "NON_ANSWER_SEEKING_QUERY_V2" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type.", - "Jail-breaking query classification type." + "Non-answer-seeking query classification type, for chit chat.", + "Jail-breaking query classification type.", + "Non-answer-seeking query classification type, for no clear intent." ], "type": "string" } @@ -12843,7 +13168,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. .", "type": "object" }, "title": { @@ -12979,13 +13304,13 @@ "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", "description": "The value of the matcher that was used to match the Document." }, - "status": { - "description": "The status of the document.", + "state": { + "description": "The state of the document.", "enum": [ - "STATUS_UNSPECIFIED", - "STATUS_INDEXED", - "STATUS_NOT_IN_TARGET_SITE", - "STATUS_NOT_IN_INDEX" + "STATE_UNSPECIFIED", + "INDEXED", + "NOT_IN_TARGET_SITE", + "NOT_IN_INDEX" ], "enumDescriptions": [ "Should never be set.", @@ -13839,7 +14164,7 @@ "type": "boolean" }, "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", + "description": "The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, "summarySpec": { @@ -14010,6 +14335,10 @@ "description": "The display name of the model.", "type": "string" }, + "errorMessage": { + "description": "Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.", + "type": "string" + }, "metrics": { "additionalProperties": { "format": "double", @@ -14048,7 +14377,7 @@ "type": "string" }, "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`. Model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, "trainingStartTime": { @@ -14063,6 +14392,11 @@ "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { + "billingEstimation": { + "$ref": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "description": "Output only. Data size estimation for billing.", + "readOnly": true + }, "contentConfig": { "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ @@ -14124,6 +14458,14 @@ "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "naturalLanguageQueryUnderstandingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "description": "Optional. Configuration for Natural Language Query Understanding." + }, + "servingConfigDataStore": { + "$ref": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "description": "Optional. Stores serving config at DataStore level." + }, "solutionTypes": { "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { @@ -14156,6 +14498,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation": { + "description": "Estimation of data size per data store.", + "id": "GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation", + "properties": { + "structuredDataSize": { + "description": "Data size for structured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "structuredDataUpdateTime": { + "description": "Last updated timestamp for structured data.", + "format": "google-datetime", + "type": "string" + }, + "unstructuredDataSize": { + "description": "Data size for unstructured data in terms of bytes.", + "format": "int64", + "type": "string" + }, + "unstructuredDataUpdateTime": { + "description": "Last updated timestamp for unstructured data.", + "format": "google-datetime", + "type": "string" + }, + "websiteDataSize": { + "description": "Data size for websites in terms of bytes.", + "format": "int64", + "type": "string" + }, + "websiteDataUpdateTime": { + "description": "Last updated timestamp for websites.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", @@ -14274,6 +14653,11 @@ "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, + "indexStatus": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus", + "description": "Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset.", + "readOnly": true + }, "indexTime": { "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", "format": "google-datetime", @@ -14327,6 +14711,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus": { + "description": "Index status of the document.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentIndexStatus", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "indexTime": { + "description": "The time when the document was indexed. If this field is populated, it means the document has been indexed.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaDocumentInfo": { "description": "Detailed document information associated with a user event.", "id": "GoogleCloudDiscoveryengineV1betaDocumentInfo", @@ -14341,7 +14744,7 @@ "type": "boolean" }, "name": { - "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "description": "The Document resource full name, of the form: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" }, "promotionIds": { @@ -14383,7 +14786,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -14551,6 +14954,10 @@ }, "type": "array" }, + "disableAnalytics": { + "description": "Optional. Whether to disable analytics for searches performed on this engine.", + "type": "boolean" + }, "displayName": { "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" @@ -14572,7 +14979,7 @@ "type": "string" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "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" }, "searchEngineConfig": { @@ -15743,6 +16150,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig": { + "description": "Configuration for Natural Language Query Understanding.", + "id": "GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig", + "properties": { + "mode": { + "description": "Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value.", + "Natural Language Query Understanding is disabled.", + "Natural Language Query Understanding is enabled." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1betaPageInfo", @@ -15808,7 +16236,7 @@ "type": "string" }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "description": "Output only. Full resource name of the project, for example `projects/{project}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, @@ -16295,6 +16723,10 @@ "description": "Request message for SiteSearchEngineService.RecrawlUris method.", "id": "GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest", "properties": { + "siteCredential": { + "description": "Optional. Full resource name of the SiteCredential, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/siteCredentials/*`. Only set to crawl private URIs.", + "type": "string" + }, "uris": { "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", "items": { @@ -16571,6 +17003,10 @@ "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "query": { "description": "Raw search query.", "type": "string" @@ -16856,6 +17292,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreJailBreakingQuery": { + "description": "Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. \"Reply in the tone of a competing company's CEO\". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead.", + "type": "boolean" + }, "ignoreLowRelevantContent": { "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", "type": "boolean" @@ -16921,6 +17361,10 @@ "dataStore": { "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" + }, + "filter": { + "description": "Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" } }, "type": "object" @@ -17071,6 +17515,27 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec": { + "description": "The specification for personalization.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "properties": { + "mode": { + "description": "The personalization mode of the search request. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "AUTO", + "DISABLED" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Mode.AUTO.", + "Personalization is enabled if data quality requirements are met.", + "Disable personalization." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", @@ -17516,13 +17981,15 @@ "ONE_BOX_TYPE_UNSPECIFIED", "PEOPLE", "ORGANIZATION", - "SLACK" + "SLACK", + "KNOWLEDGE_GRAPH" ], "enumDescriptions": [ "Default value. Should not be used.", "One Box result contains people results.", "One Box result contains organization results.", - "One Box result contains slack results." + "One Box result contains slack results.", + "One Box result contains Knowledge Graph search responses." ], "type": "string" }, @@ -17613,18 +18080,20 @@ "LLM_ADDON_NOT_ENABLED", "NO_RELEVANT_CONTENT", "JAIL_BREAKING_QUERY_IGNORED", - "CUSTOMER_POLICY_VIOLATION" + "CUSTOMER_POLICY_VIOLATION", + "NON_SUMMARY_SEEKING_QUERY_IGNORED_V2" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The non-summary seeking query ignored case. Google skips the summary if the query is chit chat. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", - "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer.", + "The non-answer seeking query ignored case. Google skips the summary if the query doesn't have clear intent. Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] is set to `true`." ], "type": "string" }, @@ -17849,6 +18318,10 @@ }, "type": "array" }, + "personalizationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec", + "description": "The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec." + }, "rankingExpression": { "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" @@ -17901,6 +18374,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaServingConfigDataStore": { + "description": "Stores information regarding the serving configurations at DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaServingConfigDataStore", + "properties": { + "disabledForServing": { + "description": "If set true, the DataStore will not be available for serving search requests.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig": { "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", "id": "GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig", @@ -18344,7 +18828,7 @@ "id": "GoogleCloudDiscoveryengineV1betaTuneEngineMetadata", "properties": { "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`", "type": "string" } }, @@ -18519,6 +19003,14 @@ "description": "Obfuscated Dasher customer ID.", "type": "string" }, + "superAdminEmailAddress": { + "description": "Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, + "superAdminServiceAccount": { + "description": "Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion.", + "type": "string" + }, "type": { "description": "The Google Workspace data source.", "enum": [ @@ -18527,15 +19019,19 @@ "GOOGLE_MAIL", "GOOGLE_SITES", "GOOGLE_CALENDAR", - "GOOGLE_GROUPS" + "GOOGLE_CHAT", + "GOOGLE_GROUPS", + "GOOGLE_KEEP" ], "enumDescriptions": [ - "Default value.", - "The data store is used to store content from Google Drive.", - "The data store is used to store content from Gmail.", - "The data store is used to store content from Google Sites.", - "The data store is used to store content from Google Calendar.", - "The data store is used to store content from Google Groups." + "Defaults to an unspecified Workspace type.", + "Workspace Data Store contains Drive data", + "Workspace Data Store contains Mail data", + "Workspace Data Store contains Sites data", + "Workspace Data Store contains Calendar data", + "Workspace Data Store contains Chat data", + "Workspace Data Store contains Groups data", + "Workspace Data Store contains Keep data" ], "type": "string" } diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index f812be87a7..5cf1c370eb 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -9267,7 +9267,7 @@ } } }, - "revision": "20240808", + "revision": "20241003", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -12345,7 +12345,7 @@ true, true, true, - false, + true, false, false, false @@ -13329,14 +13329,16 @@ "DEVICE_TYPE_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_SMART_PHONE", - "DEVICE_TYPE_TABLET" + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" ], "enumDescriptions": [ "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", "Computer.", "Connected TV.", "Smart phone.", - "Tablet." + "Tablet.", + "Connected device." ], "type": "string" }, @@ -13360,14 +13362,16 @@ "DEVICE_TYPE_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_SMART_PHONE", - "DEVICE_TYPE_TABLET" + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" ], "enumDescriptions": [ "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", "Computer.", "Connected TV.", "Smart phone.", - "Tablet." + "Tablet.", + "Connected device." ], "readOnly": true, "type": "string" @@ -16191,7 +16195,7 @@ }, "pacing": { "$ref": "Pacing", - "description": "Required. The budget spending speed setting of the insertion order." + "description": "Required. The budget spending speed setting of the insertion order. *Warning*: Starting on **November 5, 2024**, pacing_type `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT`. [Read more about this announced change](/display-video/api/deprecations#features.io_asap)." }, "partnerCosts": { "description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", @@ -18843,7 +18847,7 @@ "type": "string" }, "pacingType": { - "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.", + "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. *Warning*: Starting on **November 5, 2024**, `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. [Read more about this announced change](/display-video/api/deprecations#features.io_asap).", "enum": [ "PACING_TYPE_UNSPECIFIED", "PACING_TYPE_AHEAD", @@ -19250,6 +19254,7 @@ "PERFORMANCE_GOAL_TYPE_VIEWABILITY", "PERFORMANCE_GOAL_TYPE_CPIAVC", "PERFORMANCE_GOAL_TYPE_CPE", + "PERFORMANCE_GOAL_TYPE_CPV", "PERFORMANCE_GOAL_TYPE_CLICK_CVR", "PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR", "PERFORMANCE_GOAL_TYPE_VCPM", @@ -19267,6 +19272,7 @@ "The performance goal is set in Viewability percentage.", "The performance goal is set as CPIAVC (cost per impression audible and visible at completion).", "The performance goal is set in CPE (cost per engagement).", + "The performance goal is set in CPV (cost per view).", "The performance goal is set in click conversion rate (conversions per click) percentage.", "The performance goal is set in impression conversion rate (conversions per impression) percentage.", "The performance goal is set in VCPM (cost per thousand viewable impressions).", @@ -19856,7 +19862,7 @@ true, true, true, - false, + true, false, false, false @@ -19936,7 +19942,7 @@ true, true, true, - false, + true, false, false, false @@ -20060,8 +20066,8 @@ "Content related to motor vehicle, aviation or other transportation accidents.", "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", - "YouTube videos embedded on websites outside of YouTube.com. Only applicable to YouTube and Partners line items.", - "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." ], "type": "string" } @@ -20115,8 +20121,8 @@ "Content related to motor vehicle, aviation or other transportation accidents.", "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", - "YouTube videos embedded on websites outside of YouTube.com. Only applicable to YouTube and Partners line items.", - "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." ], "readOnly": true, "type": "string" diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index 88e0875c84..4714315479 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9222,7 +9222,7 @@ } } }, - "revision": "20240808", + "revision": "20241003", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -12920,7 +12920,7 @@ true, true, true, - false, + true, false, false, false @@ -14045,14 +14045,16 @@ "DEVICE_TYPE_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_SMART_PHONE", - "DEVICE_TYPE_TABLET" + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" ], "enumDescriptions": [ "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", "Computer.", "Connected TV.", "Smart phone.", - "Tablet." + "Tablet.", + "Connected device." ], "type": "string" }, @@ -14076,14 +14078,16 @@ "DEVICE_TYPE_COMPUTER", "DEVICE_TYPE_CONNECTED_TV", "DEVICE_TYPE_SMART_PHONE", - "DEVICE_TYPE_TABLET" + "DEVICE_TYPE_TABLET", + "DEVICE_TYPE_CONNECTED_DEVICE" ], "enumDescriptions": [ "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", "Computer.", "Connected TV.", "Smart phone.", - "Tablet." + "Tablet.", + "Connected device." ], "readOnly": true, "type": "string" @@ -16925,7 +16929,7 @@ }, "pacing": { "$ref": "Pacing", - "description": "Required. The budget spending speed setting of the insertion order." + "description": "Required. The budget spending speed setting of the insertion order. *Warning*: Starting on **November 5, 2024**, pacing_type `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT`. [Read more about this announced change](/display-video/api/deprecations#features.io_asap)." }, "partnerCosts": { "description": "The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings.", @@ -19594,7 +19598,7 @@ "type": "string" }, "pacingType": { - "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.", + "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. *Warning*: Starting on **November 5, 2024**, `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. [Read more about this announced change](/display-video/api/deprecations#features.io_asap).", "enum": [ "PACING_TYPE_UNSPECIFIED", "PACING_TYPE_AHEAD", @@ -20021,6 +20025,7 @@ "PERFORMANCE_GOAL_TYPE_VIEWABILITY", "PERFORMANCE_GOAL_TYPE_CPIAVC", "PERFORMANCE_GOAL_TYPE_CPE", + "PERFORMANCE_GOAL_TYPE_CPV", "PERFORMANCE_GOAL_TYPE_CLICK_CVR", "PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR", "PERFORMANCE_GOAL_TYPE_VCPM", @@ -20038,6 +20043,7 @@ "The performance goal is set in Viewability percentage.", "The performance goal is set as CPIAVC (cost per impression audible and visible at completion).", "The performance goal is set in CPE (cost per engagement).", + "The performance goal is set in CPV (cost per view).", "The performance goal is set in click conversion rate (conversions per click) percentage.", "The performance goal is set in impression conversion rate (conversions per impression) percentage.", "The performance goal is set in VCPM (cost per thousand viewable impressions).", @@ -20627,7 +20633,7 @@ true, true, true, - false, + true, false, false, false @@ -20707,7 +20713,7 @@ true, true, true, - false, + true, false, false, false @@ -20831,8 +20837,8 @@ "Content related to motor vehicle, aviation or other transportation accidents.", "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", - "YouTube videos embedded on websites outside of YouTube.com. Only applicable to YouTube and Partners line items.", - "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." ], "type": "string" } @@ -20886,8 +20892,8 @@ "Content related to motor vehicle, aviation or other transportation accidents.", "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", - "YouTube videos embedded on websites outside of YouTube.com. Only applicable to YouTube and Partners line items.", - "Video of live events streamed over the internet. Only applicable to YouTube and Partners line items." + "YouTube videos embedded on websites outside of YouTube.com.", + "Video of live events streamed over the internet." ], "readOnly": true, "type": "string" @@ -21048,7 +21054,7 @@ "type": "boolean" }, "enableOptimizedTargeting": { - "description": "Required. Whether to enable Optimized Targeting for the line item.", + "description": "Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`", "type": "boolean" } }, diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index b238dd11bf..f0a48c0464 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -1432,7 +1432,7 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `account_id` - The AWS account ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -4065,7 +4065,7 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `account_id` - The AWS account ID. - `file_store_path` - The path like \"gs://bucket\". - `data_source_type` - The profile's data source type, like \"google/storage/bucket\". - `data_storage_location` - The location where the file store's data is stored, like \"us-central1\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, @@ -5015,7 +5015,7 @@ } } }, - "revision": "20240825", + "revision": "20240916", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5100,6 +5100,83 @@ "properties": {}, "type": "object" }, + "GooglePrivacyDlpV2AmazonS3Bucket": { + "description": "Amazon S3 bucket.", + "id": "GooglePrivacyDlpV2AmazonS3Bucket", + "properties": { + "awsAccount": { + "$ref": "GooglePrivacyDlpV2AwsAccount", + "description": "The AWS account." + }, + "bucketName": { + "description": "Required. The bucket name.", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2AmazonS3BucketConditions": { + "description": "Amazon S3 bucket conditions.", + "id": "GooglePrivacyDlpV2AmazonS3BucketConditions", + "properties": { + "bucketTypes": { + "description": "Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified.", + "items": { + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_ALL_SUPPORTED", + "TYPE_GENERAL_PURPOSE" + ], + "enumDescriptions": [ + "Unused.", + "All supported classes.", + "A general purpose Amazon S3 bucket." + ], + "type": "string" + }, + "type": "array" + }, + "objectStorageClasses": { + "description": "Optional. Object classes that should be profiled. Optional. Defaults to ALL_SUPPORTED_CLASSES if unspecified.", + "items": { + "enum": [ + "UNSPECIFIED", + "ALL_SUPPORTED_CLASSES", + "STANDARD", + "STANDARD_INFREQUENT_ACCESS", + "GLACIER_INSTANT_RETRIEVAL", + "INTELLIGENT_TIERING" + ], + "enumDescriptions": [ + "Unused.", + "All supported classes.", + "Standard object class.", + "Standard - infrequent access object class.", + "Glacier - instant retrieval object class.", + "Objects in the S3 Intelligent-Tiering access tiers." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2AmazonS3BucketRegex": { + "description": "Amazon S3 bucket regex.", + "id": "GooglePrivacyDlpV2AmazonS3BucketRegex", + "properties": { + "awsAccountRegex": { + "$ref": "GooglePrivacyDlpV2AwsAccountRegex", + "description": "The AWS account regex." + }, + "bucketNameRegex": { + "description": "Optional. Regex to test the bucket name against. If empty, all buckets match.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails": { "description": "Result of a risk analysis operation request.", "id": "GooglePrivacyDlpV2AnalyzeDataSourceRiskDetails", @@ -5165,6 +5242,43 @@ }, "type": "object" }, + "GooglePrivacyDlpV2AwsAccount": { + "description": "AWS account.", + "id": "GooglePrivacyDlpV2AwsAccount", + "properties": { + "accountId": { + "description": "Required. AWS account ID.", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2AwsAccountRegex": { + "description": "AWS account regex.", + "id": "GooglePrivacyDlpV2AwsAccountRegex", + "properties": { + "accountIdRegex": { + "description": "Optional. Regex to test the AWS account ID against. If empty, all accounts match.", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2AwsDiscoveryStartingLocation": { + "description": "The AWS starting location for discovery.", + "id": "GooglePrivacyDlpV2AwsDiscoveryStartingLocation", + "properties": { + "accountId": { + "description": "The AWS account ID that this discovery config applies to. Within an AWS organization, you can find the AWS account ID inside an AWS account ARN. Example: arn:{partition}:organizations::{management_account_id}:account/{org_id}/{account_id}", + "type": "string" + }, + "allAssetInventoryAssets": { + "description": "All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs.", + "type": "boolean" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2BigQueryDiscoveryTarget": { "description": "Target used to match against for discovery with BigQuery tables", "id": "GooglePrivacyDlpV2BigQueryDiscoveryTarget", @@ -6525,6 +6639,14 @@ "$ref": "GooglePrivacyDlpV2PubSubNotification", "description": "Publish a message into the Pub/Sub topic." }, + "publishToChronicle": { + "$ref": "GooglePrivacyDlpV2PublishToChronicle", + "description": "Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download)." + }, + "publishToScc": { + "$ref": "GooglePrivacyDlpV2PublishToSecurityCommandCenter", + "description": "Publishes findings to SCC for each data profile." + }, "tagResources": { "$ref": "GooglePrivacyDlpV2TagResources", "description": "Tags the profiled resources with the specified tag values." @@ -6602,6 +6724,10 @@ "$ref": "GooglePrivacyDlpV2DataProfileLocation", "description": "The data to scan." }, + "otherCloudStartingLocation": { + "$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation", + "description": "Must be set only when scanning other clouds." + }, "projectId": { "description": "The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled.", "type": "string" @@ -7487,6 +7613,10 @@ "$ref": "GooglePrivacyDlpV2OrgConfig", "description": "Only set when the parent is an org." }, + "otherCloudStartingLocation": { + "$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation", + "description": "Must be set only when scanning other clouds." + }, "status": { "description": "Required. A status for this configuration.", "enum": [ @@ -7596,6 +7726,68 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DiscoveryOtherCloudConditions": { + "description": "Requirements that must be true before a resource is profiled for the first time.", + "id": "GooglePrivacyDlpV2DiscoveryOtherCloudConditions", + "properties": { + "amazonS3BucketConditions": { + "$ref": "GooglePrivacyDlpV2AmazonS3BucketConditions", + "description": "Amazon S3 bucket conditions." + }, + "minAge": { + "description": "Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryOtherCloudFilter": { + "description": "Determines which resources from the other cloud will have profiles generated. Includes the ability to filter by resource names.", + "id": "GooglePrivacyDlpV2DiscoveryOtherCloudFilter", + "properties": { + "collection": { + "$ref": "GooglePrivacyDlpV2OtherCloudResourceCollection", + "description": "A collection of resources for this filter to apply to." + }, + "others": { + "$ref": "GooglePrivacyDlpV2AllOtherResources", + "description": "Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically." + }, + "singleResource": { + "$ref": "GooglePrivacyDlpV2OtherCloudSingleResourceReference", + "description": "The resource to scan. Configs using this filter can only have one target (the target with this single resource reference)." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence": { + "description": "How often existing resources should have their profiles refreshed. New resources are scanned as quickly as possible depending on system capacity.", + "id": "GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence", + "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "description": "Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update." + }, + "refreshFrequency": { + "description": "Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never.", + "enum": [ + "UPDATE_FREQUENCY_UNSPECIFIED", + "UPDATE_FREQUENCY_NEVER", + "UPDATE_FREQUENCY_DAILY", + "UPDATE_FREQUENCY_MONTHLY" + ], + "enumDescriptions": [ + "Unspecified.", + "After the data profile is created, it will never be updated.", + "The data profile can be updated up to once every 24 hours.", + "The data profile can be updated up to once every 30 days. Default." + ], + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence": { "description": "The cadence at which to update data profiles when a schema is modified.", "id": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", @@ -7707,6 +7899,10 @@ "$ref": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget", "description": "Cloud Storage target for Discovery. The first target to match a table will be the one applied." }, + "otherCloudTarget": { + "$ref": "GooglePrivacyDlpV2OtherCloudDiscoveryTarget", + "description": "Other clouds target for discovery. The first target to match a resource will be the one applied." + }, "secretsTarget": { "$ref": "GooglePrivacyDlpV2SecretsDiscoveryTarget", "description": "Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed." @@ -8126,7 +8322,7 @@ "type": "object" }, "GooglePrivacyDlpV2FileStoreDataProfile": { - "description": "The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.", + "description": "The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket.", "id": "GooglePrivacyDlpV2FileStoreDataProfile", "properties": { "configSnapshot": { @@ -8172,15 +8368,15 @@ "type": "boolean" }, "fileStoreLocation": { - "description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations", + "description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints", "type": "string" }, "fileStorePath": { - "description": "The file store path. * Cloud Storage: `gs://{bucket}`", + "description": "The file store path. * Cloud Storage: `gs://{bucket}` * Amazon S3: `s3://{bucket}`", "type": "string" }, "fullResource": { - "description": "The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name", + "description": "The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name}`", "type": "string" }, "lastModifiedTime": { @@ -8210,7 +8406,7 @@ "type": "string" }, "projectId": { - "description": "The Google Cloud project ID that owns the resource.", + "description": "The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id.", "type": "string" }, "resourceAttributes": { @@ -10034,6 +10230,91 @@ }, "type": "object" }, + "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation": { + "description": "The other cloud starting location for discovery.", + "id": "GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation", + "properties": { + "awsLocation": { + "$ref": "GooglePrivacyDlpV2AwsDiscoveryStartingLocation", + "description": "The AWS starting location for discovery." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2OtherCloudDiscoveryTarget": { + "description": "Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature.", + "id": "GooglePrivacyDlpV2OtherCloudDiscoveryTarget", + "properties": { + "conditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudConditions", + "description": "Optional. In addition to matching the filter, these conditions must be true before a profile is generated." + }, + "dataSourceType": { + "$ref": "GooglePrivacyDlpV2DataSourceType", + "description": "Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket" + }, + "disabled": { + "$ref": "GooglePrivacyDlpV2Disabled", + "description": "Disable profiling for resources that match this filter." + }, + "filter": { + "$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudFilter", + "description": "Required. The resources that the discovery cadence applies to. The first target with a matching filter will be the one to apply to a resource." + }, + "generationCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence", + "description": "How often and when to update data profiles. New resources that match both the filter and conditions are scanned as quickly as possible depending on system capacity." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2OtherCloudResourceCollection": { + "description": "Match resources using regex filters.", + "id": "GooglePrivacyDlpV2OtherCloudResourceCollection", + "properties": { + "includeRegexes": { + "$ref": "GooglePrivacyDlpV2OtherCloudResourceRegexes", + "description": "A collection of regular expressions to match a resource against." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2OtherCloudResourceRegex": { + "description": "A pattern to match against one or more resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.", + "id": "GooglePrivacyDlpV2OtherCloudResourceRegex", + "properties": { + "amazonS3BucketRegex": { + "$ref": "GooglePrivacyDlpV2AmazonS3BucketRegex", + "description": "Regex for Amazon S3 buckets." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2OtherCloudResourceRegexes": { + "description": "A collection of regular expressions to determine what resources to match against.", + "id": "GooglePrivacyDlpV2OtherCloudResourceRegexes", + "properties": { + "patterns": { + "description": "A group of regular expression patterns to match against one or more resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.", + "items": { + "$ref": "GooglePrivacyDlpV2OtherCloudResourceRegex" + }, + "type": "array" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2OtherCloudSingleResourceReference": { + "description": "Identifies a single resource, like a single Amazon S3 bucket.", + "id": "GooglePrivacyDlpV2OtherCloudSingleResourceReference", + "properties": { + "amazonS3Bucket": { + "$ref": "GooglePrivacyDlpV2AmazonS3Bucket", + "description": "Amazon S3 bucket." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2OtherInfoTypeSummary": { "description": "Infotype details for other infoTypes found within a column.", "id": "GooglePrivacyDlpV2OtherInfoTypeSummary", @@ -10405,6 +10686,12 @@ "properties": {}, "type": "object" }, + "GooglePrivacyDlpV2PublishToChronicle": { + "description": "Message expressing intention to publish to Google Security Operations.", + "id": "GooglePrivacyDlpV2PublishToChronicle", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2PublishToPubSub": { "description": "Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk", "id": "GooglePrivacyDlpV2PublishToPubSub", @@ -10416,6 +10703,12 @@ }, "type": "object" }, + "GooglePrivacyDlpV2PublishToSecurityCommandCenter": { + "description": "If set, a summary finding will be created/updated in SCC for each profile.", + "id": "GooglePrivacyDlpV2PublishToSecurityCommandCenter", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2PublishToStackdriver": { "description": "Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'.", "id": "GooglePrivacyDlpV2PublishToStackdriver", diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index dfd690f916..79e98dbfdb 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20240813", + "revision": "20240911", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -5166,3354 +5166,6 @@ }, "type": "object" }, - "GoogleCloudDocumentaiV1beta1Barcode": { - "description": "Encodes the detailed information of a barcode.", - "id": "GoogleCloudDocumentaiV1beta1Barcode", - "properties": { - "format": { - "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", - "type": "string" - }, - "rawValue": { - "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", - "type": "string" - }, - "valueFormat": { - "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { - "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", - "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", - "properties": { - "responses": { - "description": "Responses for each individual document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", - "id": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1NormalizedVertex" - }, - "type": "array" - }, - "vertices": { - "description": "The bounding polygon vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1Document": { - "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": "GoogleCloudDocumentaiV1beta1Document", - "properties": { - "chunkedDocument": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument", - "description": "Document chunked based on chunking config." - }, - "content": { - "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", - "format": "byte", - "type": "string" - }, - "documentLayout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout", - "description": "Parsed layout of the document." - }, - "entities": { - "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity" - }, - "type": "array" - }, - "entityRelations": { - "description": "Placeholder. Relationship among Document.entities.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation" - }, - "type": "array" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error that occurred while processing this document." - }, - "mimeType": { - "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", - "type": "string" - }, - "pages": { - "description": "Visual page layout for the Document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPage" - }, - "type": "array" - }, - "revisions": { - "description": "Placeholder. Revision history of this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevision" - }, - "type": "array" - }, - "shardInfo": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentShardInfo", - "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." - }, - "text": { - "description": "Optional. UTF-8 encoded text in reading order from the document.", - "type": "string" - }, - "textChanges": { - "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextChange" - }, - "type": "array" - }, - "textStyles": { - "deprecated": true, - "description": "Styles for the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" - }, - "type": "array" - }, - "uri": { - "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument": { - "description": "Represents the chunks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument", - "properties": { - "chunks": { - "description": "List of chunks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk": { - "description": "Represents a chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk", - "properties": { - "chunkId": { - "description": "ID of the chunk.", - "type": "string" - }, - "content": { - "description": "Text content of the chunk.", - "type": "string" - }, - "pageFooters": { - "description": "Page footers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter" - }, - "type": "array" - }, - "pageHeaders": { - "description": "Page headers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader" - }, - "type": "array" - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the chunk." - }, - "sourceBlockIds": { - "description": "Unused.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter": { - "description": "Represents the page footer associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the footer." - }, - "text": { - "description": "Footer in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader": { - "description": "Represents the page header associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the header." - }, - "text": { - "description": "Header in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan": { - "description": "Represents where the chunk starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "properties": { - "pageEnd": { - "description": "Page where chunk ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where chunk starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout": { - "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout", - "properties": { - "blocks": { - "description": "List of blocks in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock": { - "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock", - "properties": { - "blockId": { - "description": "ID of the block.", - "type": "string" - }, - "listBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "description": "Block consisting of list content/structure." - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "description": "Page span of the block." - }, - "tableBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "description": "Block consisting of table content/structure." - }, - "textBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "description": "Block consisting of text content." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { - "description": "Represents a list type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "properties": { - "listEntries": { - "description": "List entries that constitute a list block.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" - }, - "type": "array" - }, - "type": { - "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { - "description": "Represents an entry in the list.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", - "properties": { - "blocks": { - "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { - "description": "Represents where the block starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "properties": { - "pageEnd": { - "description": "Page where block ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where block starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { - "description": "Represents a table type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "properties": { - "bodyRows": { - "description": "Body rows containing main table content.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - }, - "caption": { - "description": "Table caption/title.", - "type": "string" - }, - "headerRows": { - "description": "Header rows at the top of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { - "description": "Represents a cell in a table row.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", - "properties": { - "blocks": { - "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { - "description": "Represents a row in a table.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", - "properties": { - "cells": { - "description": "A table row is a list of table cells.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { - "description": "Represents a text type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "properties": { - "blocks": { - "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "text": { - "description": "Text content stored in the block.", - "type": "string" - }, - "type": { - "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntity", - "properties": { - "confidence": { - "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "id": { - "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", - "type": "string" - }, - "mentionId": { - "description": "Optional. Deprecated. Use `id` field instead.", - "type": "string" - }, - "mentionText": { - "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", - "type": "string" - }, - "normalizedValue": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", - "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." - }, - "pageAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor", - "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." - }, - "properties": { - "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "description": "Optional. The history of this annotation." - }, - "redacted": { - "description": "Optional. Whether the entity will be redacted for de-identification purposes.", - "type": "boolean" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." - }, - "type": { - "description": "Required. Entity type from a schema e.g. `Address`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": { - "description": "Parsed and normalized entity value.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", - "properties": { - "addressValue": { - "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" - }, - "booleanValue": { - "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", - "type": "boolean" - }, - "dateValue": { - "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" - }, - "datetimeValue": { - "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" - }, - "floatValue": { - "description": "Float value.", - "format": "float", - "type": "number" - }, - "integerValue": { - "description": "Integer value.", - "format": "int32", - "type": "integer" - }, - "moneyValue": { - "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntityRelation": { - "description": "Relationship between Entities.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation", - "properties": { - "objectId": { - "description": "Object entity id.", - "type": "string" - }, - "relation": { - "description": "Relationship description.", - "type": "string" - }, - "subjectId": { - "description": "Subject entity id.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPage": { - "description": "A page in a Document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPage", - "properties": { - "blocks": { - "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageBlock" - }, - "type": "array" - }, - "detectedBarcodes": { - "description": "A list of detected barcodes.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "dimension": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDimension", - "description": "Physical dimension of the page." - }, - "formFields": { - "description": "A list of visually detected form fields on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageFormField" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImage", - "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." - }, - "imageQualityScores": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores", - "description": "Image quality scores." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the page." - }, - "lines": { - "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLine" - }, - "type": "array" - }, - "pageNumber": { - "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", - "format": "int32", - "type": "integer" - }, - "paragraphs": { - "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this page." - }, - "symbols": { - "description": "A list of visually detected symbols on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol" - }, - "type": "array" - }, - "tables": { - "description": "A list of visually detected tables on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTable" - }, - "type": "array" - }, - "tokens": { - "description": "A list of visually detected tokens on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageToken" - }, - "type": "array" - }, - "transforms": { - "description": "Transformation matrices that were applied to the original document image to produce Page.image.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix" - }, - "type": "array" - }, - "visualElements": { - "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageAnchor": { - "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor", - "properties": { - "pageRefs": { - "description": "One or more references to visual page elements", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": { - "description": "Represents a weak reference to a page element within a document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." - }, - "confidence": { - "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "layoutId": { - "deprecated": true, - "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", - "type": "string" - }, - "layoutType": { - "description": "Optional. The type of the layout element that is being referenced if any.", - "enum": [ - "LAYOUT_TYPE_UNSPECIFIED", - "BLOCK", - "PARAGRAPH", - "LINE", - "TOKEN", - "VISUAL_ELEMENT", - "TABLE", - "FORM_FIELD" - ], - "enumDescriptions": [ - "Layout Unspecified.", - "References a Page.blocks element.", - "References a Page.paragraphs element.", - "References a Page.lines element.", - "References a Page.tokens element.", - "References a Page.visual_elements element.", - "Refrrences a Page.tables element.", - "References a Page.form_fields element." - ], - "type": "string" - }, - "page": { - "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageBlock": { - "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageBlock", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Block." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": { - "description": "A detected barcode.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode", - "properties": { - "barcode": { - "$ref": "GoogleCloudDocumentaiV1beta1Barcode", - "description": "Detailed barcode information of the DetectedBarcode." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for DetectedBarcode." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": { - "description": "Detected language for a structural component.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage", - "properties": { - "confidence": { - "description": "Confidence of detected language. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDimension": { - "description": "Dimension for the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDimension", - "properties": { - "height": { - "description": "Page height.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Dimension unit.", - "type": "string" - }, - "width": { - "description": "Page width.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageFormField": { - "description": "A form field detected on the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageFormField", - "properties": { - "correctedKeyText": { - "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "correctedValueText": { - "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "fieldName": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." - }, - "fieldValue": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the FormField value." - }, - "nameDetectedLanguages": { - "description": "A list of detected languages for name together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "description": "The history of this annotation." - }, - "valueDetectedLanguages": { - "description": "A list of detected languages for value together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImage": { - "description": "Rendered image contents for this page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImage", - "properties": { - "content": { - "description": "Raw byte content of the image.", - "format": "byte", - "type": "string" - }, - "height": { - "description": "Height of the image in pixels.", - "format": "int32", - "type": "integer" - }, - "mimeType": { - "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", - "type": "string" - }, - "width": { - "description": "Width of the image in pixels.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores": { - "description": "Image quality scores for the page image.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores", - "properties": { - "detectedDefects": { - "description": "A list of detected defects.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect" - }, - "type": "array" - }, - "qualityScore": { - "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect": { - "description": "Image Quality Defects", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect", - "properties": { - "confidence": { - "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", - "format": "float", - "type": "number" - }, - "type": { - "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageLayout": { - "description": "Visual element describing a layout unit on a page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "description": "The bounding polygon for the Layout." - }, - "confidence": { - "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "orientation": { - "description": "Detected orientation for the Layout.", - "enum": [ - "ORIENTATION_UNSPECIFIED", - "PAGE_UP", - "PAGE_RIGHT", - "PAGE_DOWN", - "PAGE_LEFT" - ], - "enumDescriptions": [ - "Unspecified orientation.", - "Orientation is aligned with page up.", - "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", - "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", - "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." - ], - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageLine": { - "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageLine", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Line." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageMatrix": { - "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix", - "properties": { - "cols": { - "description": "Number of columns in the matrix.", - "format": "int32", - "type": "integer" - }, - "data": { - "description": "The matrix data.", - "format": "byte", - "type": "string" - }, - "rows": { - "description": "Number of rows in the matrix.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageParagraph": { - "description": "A collection of lines that a human would perceive as a paragraph.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Paragraph." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageSymbol": { - "description": "A detected symbol.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Symbol." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTable": { - "description": "A table representation similar to HTML table structure.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTable", - "properties": { - "bodyRows": { - "description": "Body rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "headerRows": { - "description": "Header rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Table." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this table." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell": { - "description": "A cell representation inside the table.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell", - "properties": { - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for TableCell." - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow": { - "description": "A row of table cells.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow", - "properties": { - "cells": { - "description": "Cells that make up this row.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageToken": { - "description": "A detected token.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageToken", - "properties": { - "detectedBreak": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak", - "description": "Detected break at the end of a Token." - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Token." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - }, - "styleInfo": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", - "description": "Text style attributes." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": { - "description": "Detected break at the end of a Token.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak", - "properties": { - "type": { - "description": "Detected break type.", - "enum": [ - "TYPE_UNSPECIFIED", - "SPACE", - "WIDE_SPACE", - "HYPHEN" - ], - "enumDescriptions": [ - "Unspecified break type.", - "A single whitespace.", - "A wider whitespace.", - "A hyphen that indicates that a token has been split across lines." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": { - "description": "Font and other text style attributes.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the background." - }, - "bold": { - "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", - "type": "boolean" - }, - "fontSize": { - "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", - "format": "int32", - "type": "integer" - }, - "fontType": { - "description": "Name or style of the font.", - "type": "string" - }, - "fontWeight": { - "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", - "format": "int32", - "type": "integer" - }, - "handwritten": { - "description": "Whether the text is handwritten.", - "type": "boolean" - }, - "italic": { - "description": "Whether the text is italic.", - "type": "boolean" - }, - "letterSpacing": { - "description": "Letter spacing in points.", - "format": "double", - "type": "number" - }, - "pixelFontSize": { - "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", - "format": "double", - "type": "number" - }, - "smallcaps": { - "description": "Whether the text is in small caps. This feature is not supported yet.", - "type": "boolean" - }, - "strikeout": { - "description": "Whether the text is strikethrough. This feature is not supported yet.", - "type": "boolean" - }, - "subscript": { - "description": "Whether the text is a subscript. This feature is not supported yet.", - "type": "boolean" - }, - "superscript": { - "description": "Whether the text is a superscript. This feature is not supported yet.", - "type": "boolean" - }, - "textColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the text." - }, - "underlined": { - "description": "Whether the text is underlined.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": { - "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for VisualElement." - }, - "type": { - "description": "Type of the VisualElement.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentProvenance": { - "description": "Structure to identify provenance relationships between annotations in different revisions.", - "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "properties": { - "id": { - "deprecated": true, - "description": "The Id of this operation. Needs to be unique within the scope of the revision.", - "format": "int32", - "type": "integer" - }, - "parents": { - "description": "References to the original elements that are replaced.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent" - }, - "type": "array" - }, - "revision": { - "deprecated": true, - "description": "The index of the revision that produced this element.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of provenance operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "ADD", - "REMOVE", - "UPDATE", - "REPLACE", - "EVAL_REQUESTED", - "EVAL_APPROVED", - "EVAL_SKIPPED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - true, - true, - true - ], - "enumDescriptions": [ - "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", - "Add an element.", - "Remove an element identified by `parent`.", - "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", - "Currently unused. Replace an element identified by `parent`.", - "Deprecated. Request human review for the element identified by `parent`.", - "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", - "Deprecated. Element is skipped in the validation process." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": { - "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", - "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", - "properties": { - "id": { - "deprecated": true, - "description": "The id of the parent provenance.", - "format": "int32", - "type": "integer" - }, - "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", - "format": "int32", - "type": "integer" - }, - "revision": { - "description": "The index of the index into current revision's parent_ids list.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentRevision": { - "description": "Contains past or forward revisions of this document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentRevision", - "properties": { - "agent": { - "description": "If the change was made by a person specify the name or id of that person.", - "type": "string" - }, - "createTime": { - "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", - "format": "google-datetime", - "type": "string" - }, - "humanReview": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview", - "description": "Human Review information of this revision." - }, - "id": { - "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", - "type": "string" - }, - "parent": { - "deprecated": true, - "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "parentIds": { - "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", - "items": { - "type": "string" - }, - "type": "array" - }, - "processor": { - "description": "If the annotation was made by processor identify the processor by its resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": { - "description": "Human Review information of the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview", - "properties": { - "state": { - "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentShardInfo": { - "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", - "id": "GoogleCloudDocumentaiV1beta1DocumentShardInfo", - "properties": { - "shardCount": { - "description": "Total number of shards.", - "format": "int64", - "type": "string" - }, - "shardIndex": { - "description": "The 0-based index of this shard.", - "format": "int64", - "type": "string" - }, - "textOffset": { - "description": "The index of the first character in Document.text in the overall document global text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentStyle": { - "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", - "id": "GoogleCloudDocumentaiV1beta1DocumentStyle", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Text background color." - }, - "color": { - "$ref": "GoogleTypeColor", - "description": "Text color." - }, - "fontFamily": { - "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", - "type": "string" - }, - "fontSize": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", - "description": "Font size." - }, - "fontWeight": { - "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - }, - "textDecoration": { - "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", - "type": "string" - }, - "textStyle": { - "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize": { - "description": "Font size with unit.", - "id": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", - "properties": { - "size": { - "description": "Font size for the text.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextAnchor": { - "description": "Text reference indexing into the Document.text.", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "properties": { - "content": { - "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", - "type": "string" - }, - "textSegments": { - "description": "The text segments from the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": { - "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment", - "properties": { - "endIndex": { - "description": "TextSegment half open end UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - }, - "startIndex": { - "description": "TextSegment start UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextChange": { - "description": "This message is used for text changes aka. OCR corrections.", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextChange", - "properties": { - "changedText": { - "description": "The text that replaces the text identified in the `text_anchor`.", - "type": "string" - }, - "provenance": { - "deprecated": true, - "description": "The history of this annotation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance" - }, - "type": "array" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1GcsDestination": { - "description": "The Google Cloud Storage location where the output file will be written to.", - "id": "GoogleCloudDocumentaiV1beta1GcsDestination", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1GcsSource": { - "description": "The Google Cloud Storage location where the input file will be read from.", - "id": "GoogleCloudDocumentaiV1beta1GcsSource", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1InputConfig": { - "description": "The desired input location and metadata.", - "id": "GoogleCloudDocumentaiV1beta1InputConfig", - "properties": { - "gcsSource": { - "$ref": "GoogleCloudDocumentaiV1beta1GcsSource", - "description": "The Google Cloud Storage location to read the input from. This must be a single file." - }, - "mimeType": { - "description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "id": "GoogleCloudDocumentaiV1beta1NormalizedVertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1OperationMetadata": { - "description": "Contains metadata for the BatchProcessDocuments operation.", - "id": "GoogleCloudDocumentaiV1beta1OperationMetadata", - "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "ACCEPTED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request is received.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1OutputConfig": { - "description": "The desired output location and metadata.", - "id": "GoogleCloudDocumentaiV1beta1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDocumentaiV1beta1GcsDestination", - "description": "The Google Cloud Storage location to write the output to." - }, - "pagesPerShard": { - "description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse": { - "description": "Response to a single document processing request.", - "id": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse", - "properties": { - "inputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta1InputConfig", - "description": "Information about the input file. This is the same as the corresponding input config in the request." - }, - "outputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta1OutputConfig", - "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDocumentaiV1beta1Vertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Barcode": { - "description": "Encodes the detailed information of a barcode.", - "id": "GoogleCloudDocumentaiV1beta2Barcode", - "properties": { - "format": { - "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", - "type": "string" - }, - "rawValue": { - "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", - "type": "string" - }, - "valueFormat": { - "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": { - "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", - "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse", - "properties": { - "responses": { - "description": "Responses for each individual document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", - "id": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2NormalizedVertex" - }, - "type": "array" - }, - "vertices": { - "description": "The bounding polygon vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Document": { - "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": "GoogleCloudDocumentaiV1beta2Document", - "properties": { - "chunkedDocument": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument", - "description": "Document chunked based on chunking config." - }, - "content": { - "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", - "format": "byte", - "type": "string" - }, - "documentLayout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout", - "description": "Parsed layout of the document." - }, - "entities": { - "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity" - }, - "type": "array" - }, - "entityRelations": { - "description": "Placeholder. Relationship among Document.entities.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation" - }, - "type": "array" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error that occurred while processing this document." - }, - "labels": { - "description": "Labels for this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentLabel" - }, - "type": "array" - }, - "mimeType": { - "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", - "type": "string" - }, - "pages": { - "description": "Visual page layout for the Document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPage" - }, - "type": "array" - }, - "revisions": { - "description": "Placeholder. Revision history of this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevision" - }, - "type": "array" - }, - "shardInfo": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentShardInfo", - "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." - }, - "text": { - "description": "Optional. UTF-8 encoded text in reading order from the document.", - "type": "string" - }, - "textChanges": { - "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextChange" - }, - "type": "array" - }, - "textStyles": { - "deprecated": true, - "description": "Styles for the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" - }, - "type": "array" - }, - "uri": { - "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument": { - "description": "Represents the chunks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument", - "properties": { - "chunks": { - "description": "List of chunks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk": { - "description": "Represents a chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk", - "properties": { - "chunkId": { - "description": "ID of the chunk.", - "type": "string" - }, - "content": { - "description": "Text content of the chunk.", - "type": "string" - }, - "pageFooters": { - "description": "Page footers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter" - }, - "type": "array" - }, - "pageHeaders": { - "description": "Page headers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader" - }, - "type": "array" - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the chunk." - }, - "sourceBlockIds": { - "description": "Unused.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter": { - "description": "Represents the page footer associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the footer." - }, - "text": { - "description": "Footer in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader": { - "description": "Represents the page header associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the header." - }, - "text": { - "description": "Header in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan": { - "description": "Represents where the chunk starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "properties": { - "pageEnd": { - "description": "Page where chunk ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where chunk starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout": { - "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout", - "properties": { - "blocks": { - "description": "List of blocks in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock": { - "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock", - "properties": { - "blockId": { - "description": "ID of the block.", - "type": "string" - }, - "listBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "description": "Block consisting of list content/structure." - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "description": "Page span of the block." - }, - "tableBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "description": "Block consisting of table content/structure." - }, - "textBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "description": "Block consisting of text content." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { - "description": "Represents a list type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "properties": { - "listEntries": { - "description": "List entries that constitute a list block.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" - }, - "type": "array" - }, - "type": { - "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { - "description": "Represents an entry in the list.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", - "properties": { - "blocks": { - "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { - "description": "Represents where the block starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "properties": { - "pageEnd": { - "description": "Page where block ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where block starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { - "description": "Represents a table type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "properties": { - "bodyRows": { - "description": "Body rows containing main table content.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - }, - "caption": { - "description": "Table caption/title.", - "type": "string" - }, - "headerRows": { - "description": "Header rows at the top of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { - "description": "Represents a cell in a table row.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", - "properties": { - "blocks": { - "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { - "description": "Represents a row in a table.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", - "properties": { - "cells": { - "description": "A table row is a list of table cells.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { - "description": "Represents a text type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "properties": { - "blocks": { - "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "text": { - "description": "Text content stored in the block.", - "type": "string" - }, - "type": { - "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntity", - "properties": { - "confidence": { - "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "id": { - "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", - "type": "string" - }, - "mentionId": { - "description": "Optional. Deprecated. Use `id` field instead.", - "type": "string" - }, - "mentionText": { - "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", - "type": "string" - }, - "normalizedValue": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", - "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." - }, - "pageAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor", - "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." - }, - "properties": { - "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "description": "Optional. The history of this annotation." - }, - "redacted": { - "description": "Optional. Whether the entity will be redacted for de-identification purposes.", - "type": "boolean" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." - }, - "type": { - "description": "Required. Entity type from a schema e.g. `Address`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": { - "description": "Parsed and normalized entity value.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", - "properties": { - "addressValue": { - "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" - }, - "booleanValue": { - "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", - "type": "boolean" - }, - "dateValue": { - "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" - }, - "datetimeValue": { - "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" - }, - "floatValue": { - "description": "Float value.", - "format": "float", - "type": "number" - }, - "integerValue": { - "description": "Integer value.", - "format": "int32", - "type": "integer" - }, - "moneyValue": { - "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntityRelation": { - "description": "Relationship between Entities.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation", - "properties": { - "objectId": { - "description": "Object entity id.", - "type": "string" - }, - "relation": { - "description": "Relationship description.", - "type": "string" - }, - "subjectId": { - "description": "Subject entity id.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentLabel": { - "description": "Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.", - "id": "GoogleCloudDocumentaiV1beta2DocumentLabel", - "properties": { - "automlModel": { - "description": "Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`", - "type": "string" - }, - "confidence": { - "description": "Confidence score between 0 and 1 for label assignment.", - "format": "float", - "type": "number" - }, - "name": { - "description": "Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPage": { - "description": "A page in a Document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPage", - "properties": { - "blocks": { - "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageBlock" - }, - "type": "array" - }, - "detectedBarcodes": { - "description": "A list of detected barcodes.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "dimension": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDimension", - "description": "Physical dimension of the page." - }, - "formFields": { - "description": "A list of visually detected form fields on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageFormField" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImage", - "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." - }, - "imageQualityScores": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores", - "description": "Image quality scores." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the page." - }, - "lines": { - "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLine" - }, - "type": "array" - }, - "pageNumber": { - "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", - "format": "int32", - "type": "integer" - }, - "paragraphs": { - "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this page." - }, - "symbols": { - "description": "A list of visually detected symbols on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol" - }, - "type": "array" - }, - "tables": { - "description": "A list of visually detected tables on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTable" - }, - "type": "array" - }, - "tokens": { - "description": "A list of visually detected tokens on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageToken" - }, - "type": "array" - }, - "transforms": { - "description": "Transformation matrices that were applied to the original document image to produce Page.image.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix" - }, - "type": "array" - }, - "visualElements": { - "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageAnchor": { - "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor", - "properties": { - "pageRefs": { - "description": "One or more references to visual page elements", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": { - "description": "Represents a weak reference to a page element within a document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." - }, - "confidence": { - "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "layoutId": { - "deprecated": true, - "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", - "type": "string" - }, - "layoutType": { - "description": "Optional. The type of the layout element that is being referenced if any.", - "enum": [ - "LAYOUT_TYPE_UNSPECIFIED", - "BLOCK", - "PARAGRAPH", - "LINE", - "TOKEN", - "VISUAL_ELEMENT", - "TABLE", - "FORM_FIELD" - ], - "enumDescriptions": [ - "Layout Unspecified.", - "References a Page.blocks element.", - "References a Page.paragraphs element.", - "References a Page.lines element.", - "References a Page.tokens element.", - "References a Page.visual_elements element.", - "Refrrences a Page.tables element.", - "References a Page.form_fields element." - ], - "type": "string" - }, - "page": { - "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageBlock": { - "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageBlock", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Block." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": { - "description": "A detected barcode.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode", - "properties": { - "barcode": { - "$ref": "GoogleCloudDocumentaiV1beta2Barcode", - "description": "Detailed barcode information of the DetectedBarcode." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for DetectedBarcode." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": { - "description": "Detected language for a structural component.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage", - "properties": { - "confidence": { - "description": "Confidence of detected language. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDimension": { - "description": "Dimension for the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDimension", - "properties": { - "height": { - "description": "Page height.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Dimension unit.", - "type": "string" - }, - "width": { - "description": "Page width.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageFormField": { - "description": "A form field detected on the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageFormField", - "properties": { - "correctedKeyText": { - "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "correctedValueText": { - "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "fieldName": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." - }, - "fieldValue": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the FormField value." - }, - "nameDetectedLanguages": { - "description": "A list of detected languages for name together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "description": "The history of this annotation." - }, - "valueDetectedLanguages": { - "description": "A list of detected languages for value together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImage": { - "description": "Rendered image contents for this page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImage", - "properties": { - "content": { - "description": "Raw byte content of the image.", - "format": "byte", - "type": "string" - }, - "height": { - "description": "Height of the image in pixels.", - "format": "int32", - "type": "integer" - }, - "mimeType": { - "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", - "type": "string" - }, - "width": { - "description": "Width of the image in pixels.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores": { - "description": "Image quality scores for the page image.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores", - "properties": { - "detectedDefects": { - "description": "A list of detected defects.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect" - }, - "type": "array" - }, - "qualityScore": { - "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect": { - "description": "Image Quality Defects", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect", - "properties": { - "confidence": { - "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", - "format": "float", - "type": "number" - }, - "type": { - "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageLayout": { - "description": "Visual element describing a layout unit on a page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "description": "The bounding polygon for the Layout." - }, - "confidence": { - "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "orientation": { - "description": "Detected orientation for the Layout.", - "enum": [ - "ORIENTATION_UNSPECIFIED", - "PAGE_UP", - "PAGE_RIGHT", - "PAGE_DOWN", - "PAGE_LEFT" - ], - "enumDescriptions": [ - "Unspecified orientation.", - "Orientation is aligned with page up.", - "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", - "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", - "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." - ], - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageLine": { - "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageLine", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Line." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageMatrix": { - "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix", - "properties": { - "cols": { - "description": "Number of columns in the matrix.", - "format": "int32", - "type": "integer" - }, - "data": { - "description": "The matrix data.", - "format": "byte", - "type": "string" - }, - "rows": { - "description": "Number of rows in the matrix.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageParagraph": { - "description": "A collection of lines that a human would perceive as a paragraph.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Paragraph." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageSymbol": { - "description": "A detected symbol.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Symbol." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTable": { - "description": "A table representation similar to HTML table structure.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTable", - "properties": { - "bodyRows": { - "description": "Body rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "headerRows": { - "description": "Header rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Table." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this table." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell": { - "description": "A cell representation inside the table.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell", - "properties": { - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for TableCell." - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow": { - "description": "A row of table cells.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow", - "properties": { - "cells": { - "description": "Cells that make up this row.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageToken": { - "description": "A detected token.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageToken", - "properties": { - "detectedBreak": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak", - "description": "Detected break at the end of a Token." - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Token." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - }, - "styleInfo": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", - "description": "Text style attributes." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": { - "description": "Detected break at the end of a Token.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak", - "properties": { - "type": { - "description": "Detected break type.", - "enum": [ - "TYPE_UNSPECIFIED", - "SPACE", - "WIDE_SPACE", - "HYPHEN" - ], - "enumDescriptions": [ - "Unspecified break type.", - "A single whitespace.", - "A wider whitespace.", - "A hyphen that indicates that a token has been split across lines." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": { - "description": "Font and other text style attributes.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the background." - }, - "bold": { - "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", - "type": "boolean" - }, - "fontSize": { - "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", - "format": "int32", - "type": "integer" - }, - "fontType": { - "description": "Name or style of the font.", - "type": "string" - }, - "fontWeight": { - "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", - "format": "int32", - "type": "integer" - }, - "handwritten": { - "description": "Whether the text is handwritten.", - "type": "boolean" - }, - "italic": { - "description": "Whether the text is italic.", - "type": "boolean" - }, - "letterSpacing": { - "description": "Letter spacing in points.", - "format": "double", - "type": "number" - }, - "pixelFontSize": { - "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", - "format": "double", - "type": "number" - }, - "smallcaps": { - "description": "Whether the text is in small caps. This feature is not supported yet.", - "type": "boolean" - }, - "strikeout": { - "description": "Whether the text is strikethrough. This feature is not supported yet.", - "type": "boolean" - }, - "subscript": { - "description": "Whether the text is a subscript. This feature is not supported yet.", - "type": "boolean" - }, - "superscript": { - "description": "Whether the text is a superscript. This feature is not supported yet.", - "type": "boolean" - }, - "textColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the text." - }, - "underlined": { - "description": "Whether the text is underlined.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": { - "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for VisualElement." - }, - "type": { - "description": "Type of the VisualElement.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentProvenance": { - "description": "Structure to identify provenance relationships between annotations in different revisions.", - "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "properties": { - "id": { - "deprecated": true, - "description": "The Id of this operation. Needs to be unique within the scope of the revision.", - "format": "int32", - "type": "integer" - }, - "parents": { - "description": "References to the original elements that are replaced.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent" - }, - "type": "array" - }, - "revision": { - "deprecated": true, - "description": "The index of the revision that produced this element.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of provenance operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "ADD", - "REMOVE", - "UPDATE", - "REPLACE", - "EVAL_REQUESTED", - "EVAL_APPROVED", - "EVAL_SKIPPED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - true, - true, - true - ], - "enumDescriptions": [ - "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", - "Add an element.", - "Remove an element identified by `parent`.", - "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", - "Currently unused. Replace an element identified by `parent`.", - "Deprecated. Request human review for the element identified by `parent`.", - "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", - "Deprecated. Element is skipped in the validation process." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": { - "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", - "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", - "properties": { - "id": { - "deprecated": true, - "description": "The id of the parent provenance.", - "format": "int32", - "type": "integer" - }, - "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", - "format": "int32", - "type": "integer" - }, - "revision": { - "description": "The index of the index into current revision's parent_ids list.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentRevision": { - "description": "Contains past or forward revisions of this document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentRevision", - "properties": { - "agent": { - "description": "If the change was made by a person specify the name or id of that person.", - "type": "string" - }, - "createTime": { - "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", - "format": "google-datetime", - "type": "string" - }, - "humanReview": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview", - "description": "Human Review information of this revision." - }, - "id": { - "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", - "type": "string" - }, - "parent": { - "deprecated": true, - "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "parentIds": { - "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", - "items": { - "type": "string" - }, - "type": "array" - }, - "processor": { - "description": "If the annotation was made by processor identify the processor by its resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": { - "description": "Human Review information of the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview", - "properties": { - "state": { - "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentShardInfo": { - "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", - "id": "GoogleCloudDocumentaiV1beta2DocumentShardInfo", - "properties": { - "shardCount": { - "description": "Total number of shards.", - "format": "int64", - "type": "string" - }, - "shardIndex": { - "description": "The 0-based index of this shard.", - "format": "int64", - "type": "string" - }, - "textOffset": { - "description": "The index of the first character in Document.text in the overall document global text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentStyle": { - "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", - "id": "GoogleCloudDocumentaiV1beta2DocumentStyle", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Text background color." - }, - "color": { - "$ref": "GoogleTypeColor", - "description": "Text color." - }, - "fontFamily": { - "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", - "type": "string" - }, - "fontSize": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", - "description": "Font size." - }, - "fontWeight": { - "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - }, - "textDecoration": { - "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", - "type": "string" - }, - "textStyle": { - "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize": { - "description": "Font size with unit.", - "id": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", - "properties": { - "size": { - "description": "Font size for the text.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextAnchor": { - "description": "Text reference indexing into the Document.text.", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "properties": { - "content": { - "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", - "type": "string" - }, - "textSegments": { - "description": "The text segments from the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": { - "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment", - "properties": { - "endIndex": { - "description": "TextSegment half open end UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - }, - "startIndex": { - "description": "TextSegment start UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextChange": { - "description": "This message is used for text changes aka. OCR corrections.", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextChange", - "properties": { - "changedText": { - "description": "The text that replaces the text identified in the `text_anchor`.", - "type": "string" - }, - "provenance": { - "deprecated": true, - "description": "The history of this annotation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance" - }, - "type": "array" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2GcsDestination": { - "description": "The Google Cloud Storage location where the output file will be written to.", - "id": "GoogleCloudDocumentaiV1beta2GcsDestination", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2GcsSource": { - "description": "The Google Cloud Storage location where the input file will be read from.", - "id": "GoogleCloudDocumentaiV1beta2GcsSource", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2InputConfig": { - "description": "The desired input location and metadata.", - "id": "GoogleCloudDocumentaiV1beta2InputConfig", - "properties": { - "contents": { - "description": "Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method.", - "format": "byte", - "type": "string" - }, - "gcsSource": { - "$ref": "GoogleCloudDocumentaiV1beta2GcsSource", - "description": "The Google Cloud Storage location to read the input from. This must be a single file." - }, - "mimeType": { - "description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2NormalizedVertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "id": "GoogleCloudDocumentaiV1beta2NormalizedVertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2OperationMetadata": { - "description": "Contains metadata for the BatchProcessDocuments operation.", - "id": "GoogleCloudDocumentaiV1beta2OperationMetadata", - "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "ACCEPTED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request is received.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2OutputConfig": { - "description": "The desired output location and metadata.", - "id": "GoogleCloudDocumentaiV1beta2OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDocumentaiV1beta2GcsDestination", - "description": "The Google Cloud Storage location to write the output to." - }, - "pagesPerShard": { - "description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": { - "description": "Response to a single document processing request.", - "id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse", - "properties": { - "inputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2InputConfig", - "description": "Information about the input file. This is the same as the corresponding input config in the request." - }, - "outputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2OutputConfig", - "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDocumentaiV1beta2Vertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata": { "id": "GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata", "properties": { diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 7cb71d0cf2..3011756e12 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1284,7 +1284,7 @@ } } }, - "revision": "20240813", + "revision": "20240911", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -2569,3354 +2569,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudDocumentaiV1beta1Barcode": { - "description": "Encodes the detailed information of a barcode.", - "id": "GoogleCloudDocumentaiV1beta1Barcode", - "properties": { - "format": { - "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", - "type": "string" - }, - "rawValue": { - "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", - "type": "string" - }, - "valueFormat": { - "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse": { - "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", - "id": "GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse", - "properties": { - "responses": { - "description": "Responses for each individual document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", - "id": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1NormalizedVertex" - }, - "type": "array" - }, - "vertices": { - "description": "The bounding polygon vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1Document": { - "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": "GoogleCloudDocumentaiV1beta1Document", - "properties": { - "chunkedDocument": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument", - "description": "Document chunked based on chunking config." - }, - "content": { - "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", - "format": "byte", - "type": "string" - }, - "documentLayout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout", - "description": "Parsed layout of the document." - }, - "entities": { - "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity" - }, - "type": "array" - }, - "entityRelations": { - "description": "Placeholder. Relationship among Document.entities.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation" - }, - "type": "array" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error that occurred while processing this document." - }, - "mimeType": { - "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", - "type": "string" - }, - "pages": { - "description": "Visual page layout for the Document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPage" - }, - "type": "array" - }, - "revisions": { - "description": "Placeholder. Revision history of this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevision" - }, - "type": "array" - }, - "shardInfo": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentShardInfo", - "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." - }, - "text": { - "description": "Optional. UTF-8 encoded text in reading order from the document.", - "type": "string" - }, - "textChanges": { - "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextChange" - }, - "type": "array" - }, - "textStyles": { - "deprecated": true, - "description": "Styles for the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyle" - }, - "type": "array" - }, - "uri": { - "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument": { - "description": "Represents the chunks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocument", - "properties": { - "chunks": { - "description": "List of chunks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk": { - "description": "Represents a chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk", - "properties": { - "chunkId": { - "description": "ID of the chunk.", - "type": "string" - }, - "content": { - "description": "Text content of the chunk.", - "type": "string" - }, - "pageFooters": { - "description": "Page footers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter" - }, - "type": "array" - }, - "pageHeaders": { - "description": "Page headers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader" - }, - "type": "array" - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the chunk." - }, - "sourceBlockIds": { - "description": "Unused.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter": { - "description": "Represents the page footer associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the footer." - }, - "text": { - "description": "Footer in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader": { - "description": "Represents the page header associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the header." - }, - "text": { - "description": "Header in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan": { - "description": "Represents where the chunk starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan", - "properties": { - "pageEnd": { - "description": "Page where chunk ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where chunk starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout": { - "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayout", - "properties": { - "blocks": { - "description": "List of blocks in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock": { - "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock", - "properties": { - "blockId": { - "description": "ID of the block.", - "type": "string" - }, - "listBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "description": "Block consisting of list content/structure." - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "description": "Page span of the block." - }, - "tableBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "description": "Block consisting of table content/structure." - }, - "textBlock": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "description": "Block consisting of text content." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { - "description": "Represents a list type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "properties": { - "listEntries": { - "description": "List entries that constitute a list block.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" - }, - "type": "array" - }, - "type": { - "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { - "description": "Represents an entry in the list.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", - "properties": { - "blocks": { - "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { - "description": "Represents where the block starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "properties": { - "pageEnd": { - "description": "Page where block ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where block starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { - "description": "Represents a table type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "properties": { - "bodyRows": { - "description": "Body rows containing main table content.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - }, - "caption": { - "description": "Table caption/title.", - "type": "string" - }, - "headerRows": { - "description": "Header rows at the top of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { - "description": "Represents a cell in a table row.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", - "properties": { - "blocks": { - "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { - "description": "Represents a row in a table.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", - "properties": { - "cells": { - "description": "A table row is a list of table cells.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { - "description": "Represents a text type block.", - "id": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "properties": { - "blocks": { - "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "text": { - "description": "Text content stored in the block.", - "type": "string" - }, - "type": { - "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntity", - "properties": { - "confidence": { - "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "id": { - "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", - "type": "string" - }, - "mentionId": { - "description": "Optional. Deprecated. Use `id` field instead.", - "type": "string" - }, - "mentionText": { - "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", - "type": "string" - }, - "normalizedValue": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", - "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." - }, - "pageAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor", - "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." - }, - "properties": { - "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentEntity" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "description": "Optional. The history of this annotation." - }, - "redacted": { - "description": "Optional. Whether the entity will be redacted for de-identification purposes.", - "type": "boolean" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." - }, - "type": { - "description": "Required. Entity type from a schema e.g. `Address`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue": { - "description": "Parsed and normalized entity value.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue", - "properties": { - "addressValue": { - "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" - }, - "booleanValue": { - "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", - "type": "boolean" - }, - "dateValue": { - "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" - }, - "datetimeValue": { - "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" - }, - "floatValue": { - "description": "Float value.", - "format": "float", - "type": "number" - }, - "integerValue": { - "description": "Integer value.", - "format": "int32", - "type": "integer" - }, - "moneyValue": { - "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentEntityRelation": { - "description": "Relationship between Entities.", - "id": "GoogleCloudDocumentaiV1beta1DocumentEntityRelation", - "properties": { - "objectId": { - "description": "Object entity id.", - "type": "string" - }, - "relation": { - "description": "Relationship description.", - "type": "string" - }, - "subjectId": { - "description": "Subject entity id.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPage": { - "description": "A page in a Document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPage", - "properties": { - "blocks": { - "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageBlock" - }, - "type": "array" - }, - "detectedBarcodes": { - "description": "A list of detected barcodes.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "dimension": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDimension", - "description": "Physical dimension of the page." - }, - "formFields": { - "description": "A list of visually detected form fields on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageFormField" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImage", - "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." - }, - "imageQualityScores": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores", - "description": "Image quality scores." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the page." - }, - "lines": { - "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLine" - }, - "type": "array" - }, - "pageNumber": { - "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", - "format": "int32", - "type": "integer" - }, - "paragraphs": { - "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this page." - }, - "symbols": { - "description": "A list of visually detected symbols on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol" - }, - "type": "array" - }, - "tables": { - "description": "A list of visually detected tables on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTable" - }, - "type": "array" - }, - "tokens": { - "description": "A list of visually detected tokens on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageToken" - }, - "type": "array" - }, - "transforms": { - "description": "Transformation matrices that were applied to the original document image to produce Page.image.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix" - }, - "type": "array" - }, - "visualElements": { - "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageAnchor": { - "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchor", - "properties": { - "pageRefs": { - "description": "One or more references to visual page elements", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef": { - "description": "Represents a weak reference to a page element within a document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." - }, - "confidence": { - "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "layoutId": { - "deprecated": true, - "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", - "type": "string" - }, - "layoutType": { - "description": "Optional. The type of the layout element that is being referenced if any.", - "enum": [ - "LAYOUT_TYPE_UNSPECIFIED", - "BLOCK", - "PARAGRAPH", - "LINE", - "TOKEN", - "VISUAL_ELEMENT", - "TABLE", - "FORM_FIELD" - ], - "enumDescriptions": [ - "Layout Unspecified.", - "References a Page.blocks element.", - "References a Page.paragraphs element.", - "References a Page.lines element.", - "References a Page.tokens element.", - "References a Page.visual_elements element.", - "Refrrences a Page.tables element.", - "References a Page.form_fields element." - ], - "type": "string" - }, - "page": { - "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageBlock": { - "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageBlock", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Block." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode": { - "description": "A detected barcode.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode", - "properties": { - "barcode": { - "$ref": "GoogleCloudDocumentaiV1beta1Barcode", - "description": "Detailed barcode information of the DetectedBarcode." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for DetectedBarcode." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage": { - "description": "Detected language for a structural component.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage", - "properties": { - "confidence": { - "description": "Confidence of detected language. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageDimension": { - "description": "Dimension for the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageDimension", - "properties": { - "height": { - "description": "Page height.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Dimension unit.", - "type": "string" - }, - "width": { - "description": "Page width.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageFormField": { - "description": "A form field detected on the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageFormField", - "properties": { - "correctedKeyText": { - "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "correctedValueText": { - "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "fieldName": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." - }, - "fieldValue": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for the FormField value." - }, - "nameDetectedLanguages": { - "description": "A list of detected languages for name together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "description": "The history of this annotation." - }, - "valueDetectedLanguages": { - "description": "A list of detected languages for value together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImage": { - "description": "Rendered image contents for this page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImage", - "properties": { - "content": { - "description": "Raw byte content of the image.", - "format": "byte", - "type": "string" - }, - "height": { - "description": "Height of the image in pixels.", - "format": "int32", - "type": "integer" - }, - "mimeType": { - "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", - "type": "string" - }, - "width": { - "description": "Width of the image in pixels.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores": { - "description": "Image quality scores for the page image.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores", - "properties": { - "detectedDefects": { - "description": "A list of detected defects.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect" - }, - "type": "array" - }, - "qualityScore": { - "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect": { - "description": "Image Quality Defects", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect", - "properties": { - "confidence": { - "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", - "format": "float", - "type": "number" - }, - "type": { - "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageLayout": { - "description": "Visual element describing a layout unit on a page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta1BoundingPoly", - "description": "The bounding polygon for the Layout." - }, - "confidence": { - "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "orientation": { - "description": "Detected orientation for the Layout.", - "enum": [ - "ORIENTATION_UNSPECIFIED", - "PAGE_UP", - "PAGE_RIGHT", - "PAGE_DOWN", - "PAGE_LEFT" - ], - "enumDescriptions": [ - "Unspecified orientation.", - "Orientation is aligned with page up.", - "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", - "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", - "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." - ], - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageLine": { - "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageLine", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Line." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageMatrix": { - "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageMatrix", - "properties": { - "cols": { - "description": "Number of columns in the matrix.", - "format": "int32", - "type": "integer" - }, - "data": { - "description": "The matrix data.", - "format": "byte", - "type": "string" - }, - "rows": { - "description": "Number of rows in the matrix.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageParagraph": { - "description": "A collection of lines that a human would perceive as a paragraph.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageParagraph", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Paragraph." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageSymbol": { - "description": "A detected symbol.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageSymbol", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Symbol." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTable": { - "description": "A table representation similar to HTML table structure.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTable", - "properties": { - "bodyRows": { - "description": "Body rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "headerRows": { - "description": "Header rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Table." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this table." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell": { - "description": "A cell representation inside the table.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell", - "properties": { - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for TableCell." - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow": { - "description": "A row of table cells.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow", - "properties": { - "cells": { - "description": "Cells that make up this row.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageToken": { - "description": "A detected token.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageToken", - "properties": { - "detectedBreak": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak", - "description": "Detected break at the end of a Token." - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for Token." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - }, - "styleInfo": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", - "description": "Text style attributes." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak": { - "description": "Detected break at the end of a Token.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak", - "properties": { - "type": { - "description": "Detected break type.", - "enum": [ - "TYPE_UNSPECIFIED", - "SPACE", - "WIDE_SPACE", - "HYPHEN" - ], - "enumDescriptions": [ - "Unspecified break type.", - "A single whitespace.", - "A wider whitespace.", - "A hyphen that indicates that a token has been split across lines." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo": { - "description": "Font and other text style attributes.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the background." - }, - "bold": { - "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", - "type": "boolean" - }, - "fontSize": { - "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", - "format": "int32", - "type": "integer" - }, - "fontType": { - "description": "Name or style of the font.", - "type": "string" - }, - "fontWeight": { - "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", - "format": "int32", - "type": "integer" - }, - "handwritten": { - "description": "Whether the text is handwritten.", - "type": "boolean" - }, - "italic": { - "description": "Whether the text is italic.", - "type": "boolean" - }, - "letterSpacing": { - "description": "Letter spacing in points.", - "format": "double", - "type": "number" - }, - "pixelFontSize": { - "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", - "format": "double", - "type": "number" - }, - "smallcaps": { - "description": "Whether the text is in small caps. This feature is not supported yet.", - "type": "boolean" - }, - "strikeout": { - "description": "Whether the text is strikethrough. This feature is not supported yet.", - "type": "boolean" - }, - "subscript": { - "description": "Whether the text is a subscript. This feature is not supported yet.", - "type": "boolean" - }, - "superscript": { - "description": "Whether the text is a superscript. This feature is not supported yet.", - "type": "boolean" - }, - "textColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the text." - }, - "underlined": { - "description": "Whether the text is underlined.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement": { - "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "id": "GoogleCloudDocumentaiV1beta1DocumentPageVisualElement", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentPageLayout", - "description": "Layout for VisualElement." - }, - "type": { - "description": "Type of the VisualElement.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentProvenance": { - "description": "Structure to identify provenance relationships between annotations in different revisions.", - "id": "GoogleCloudDocumentaiV1beta1DocumentProvenance", - "properties": { - "id": { - "deprecated": true, - "description": "The Id of this operation. Needs to be unique within the scope of the revision.", - "format": "int32", - "type": "integer" - }, - "parents": { - "description": "References to the original elements that are replaced.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent" - }, - "type": "array" - }, - "revision": { - "deprecated": true, - "description": "The index of the revision that produced this element.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of provenance operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "ADD", - "REMOVE", - "UPDATE", - "REPLACE", - "EVAL_REQUESTED", - "EVAL_APPROVED", - "EVAL_SKIPPED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - true, - true, - true - ], - "enumDescriptions": [ - "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", - "Add an element.", - "Remove an element identified by `parent`.", - "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", - "Currently unused. Replace an element identified by `parent`.", - "Deprecated. Request human review for the element identified by `parent`.", - "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", - "Deprecated. Element is skipped in the validation process." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent": { - "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", - "id": "GoogleCloudDocumentaiV1beta1DocumentProvenanceParent", - "properties": { - "id": { - "deprecated": true, - "description": "The id of the parent provenance.", - "format": "int32", - "type": "integer" - }, - "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", - "format": "int32", - "type": "integer" - }, - "revision": { - "description": "The index of the index into current revision's parent_ids list.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentRevision": { - "description": "Contains past or forward revisions of this document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentRevision", - "properties": { - "agent": { - "description": "If the change was made by a person specify the name or id of that person.", - "type": "string" - }, - "createTime": { - "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", - "format": "google-datetime", - "type": "string" - }, - "humanReview": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview", - "description": "Human Review information of this revision." - }, - "id": { - "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", - "type": "string" - }, - "parent": { - "deprecated": true, - "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "parentIds": { - "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", - "items": { - "type": "string" - }, - "type": "array" - }, - "processor": { - "description": "If the annotation was made by processor identify the processor by its resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview": { - "description": "Human Review information of the document.", - "id": "GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview", - "properties": { - "state": { - "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentShardInfo": { - "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", - "id": "GoogleCloudDocumentaiV1beta1DocumentShardInfo", - "properties": { - "shardCount": { - "description": "Total number of shards.", - "format": "int64", - "type": "string" - }, - "shardIndex": { - "description": "The 0-based index of this shard.", - "format": "int64", - "type": "string" - }, - "textOffset": { - "description": "The index of the first character in Document.text in the overall document global text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentStyle": { - "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", - "id": "GoogleCloudDocumentaiV1beta1DocumentStyle", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Text background color." - }, - "color": { - "$ref": "GoogleTypeColor", - "description": "Text color." - }, - "fontFamily": { - "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", - "type": "string" - }, - "fontSize": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", - "description": "Font size." - }, - "fontWeight": { - "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - }, - "textDecoration": { - "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", - "type": "string" - }, - "textStyle": { - "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize": { - "description": "Font size with unit.", - "id": "GoogleCloudDocumentaiV1beta1DocumentStyleFontSize", - "properties": { - "size": { - "description": "Font size for the text.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextAnchor": { - "description": "Text reference indexing into the Document.text.", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "properties": { - "content": { - "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", - "type": "string" - }, - "textSegments": { - "description": "The text segments from the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment": { - "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment", - "properties": { - "endIndex": { - "description": "TextSegment half open end UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - }, - "startIndex": { - "description": "TextSegment start UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1DocumentTextChange": { - "description": "This message is used for text changes aka. OCR corrections.", - "id": "GoogleCloudDocumentaiV1beta1DocumentTextChange", - "properties": { - "changedText": { - "description": "The text that replaces the text identified in the `text_anchor`.", - "type": "string" - }, - "provenance": { - "deprecated": true, - "description": "The history of this annotation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentProvenance" - }, - "type": "array" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta1DocumentTextAnchor", - "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1GcsDestination": { - "description": "The Google Cloud Storage location where the output file will be written to.", - "id": "GoogleCloudDocumentaiV1beta1GcsDestination", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1GcsSource": { - "description": "The Google Cloud Storage location where the input file will be read from.", - "id": "GoogleCloudDocumentaiV1beta1GcsSource", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1InputConfig": { - "description": "The desired input location and metadata.", - "id": "GoogleCloudDocumentaiV1beta1InputConfig", - "properties": { - "gcsSource": { - "$ref": "GoogleCloudDocumentaiV1beta1GcsSource", - "description": "The Google Cloud Storage location to read the input from. This must be a single file." - }, - "mimeType": { - "description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1NormalizedVertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "id": "GoogleCloudDocumentaiV1beta1NormalizedVertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1OperationMetadata": { - "description": "Contains metadata for the BatchProcessDocuments operation.", - "id": "GoogleCloudDocumentaiV1beta1OperationMetadata", - "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "ACCEPTED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request is received.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1OutputConfig": { - "description": "The desired output location and metadata.", - "id": "GoogleCloudDocumentaiV1beta1OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDocumentaiV1beta1GcsDestination", - "description": "The Google Cloud Storage location to write the output to." - }, - "pagesPerShard": { - "description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse": { - "description": "Response to a single document processing request.", - "id": "GoogleCloudDocumentaiV1beta1ProcessDocumentResponse", - "properties": { - "inputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta1InputConfig", - "description": "Information about the input file. This is the same as the corresponding input config in the request." - }, - "outputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta1OutputConfig", - "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta1Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDocumentaiV1beta1Vertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Barcode": { - "description": "Encodes the detailed information of a barcode.", - "id": "GoogleCloudDocumentaiV1beta2Barcode", - "properties": { - "format": { - "description": "Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type.", - "type": "string" - }, - "rawValue": { - "description": "Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`.", - "type": "string" - }, - "valueFormat": { - "description": "Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse": { - "description": "Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete.", - "id": "GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse", - "properties": { - "responses": { - "description": "Responses for each individual document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", - "id": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "properties": { - "normalizedVertices": { - "description": "The bounding polygon normalized vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2NormalizedVertex" - }, - "type": "array" - }, - "vertices": { - "description": "The bounding polygon vertices.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2Vertex" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Document": { - "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": "GoogleCloudDocumentaiV1beta2Document", - "properties": { - "chunkedDocument": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument", - "description": "Document chunked based on chunking config." - }, - "content": { - "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", - "format": "byte", - "type": "string" - }, - "documentLayout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout", - "description": "Parsed layout of the document." - }, - "entities": { - "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity" - }, - "type": "array" - }, - "entityRelations": { - "description": "Placeholder. Relationship among Document.entities.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation" - }, - "type": "array" - }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "Any error that occurred while processing this document." - }, - "labels": { - "description": "Labels for this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentLabel" - }, - "type": "array" - }, - "mimeType": { - "description": "An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).", - "type": "string" - }, - "pages": { - "description": "Visual page layout for the Document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPage" - }, - "type": "array" - }, - "revisions": { - "description": "Placeholder. Revision history of this document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevision" - }, - "type": "array" - }, - "shardInfo": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentShardInfo", - "description": "Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified." - }, - "text": { - "description": "Optional. UTF-8 encoded text in reading order from the document.", - "type": "string" - }, - "textChanges": { - "description": "Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextChange" - }, - "type": "array" - }, - "textStyles": { - "deprecated": true, - "description": "Styles for the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyle" - }, - "type": "array" - }, - "uri": { - "description": "Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument": { - "description": "Represents the chunks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocument", - "properties": { - "chunks": { - "description": "List of chunks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk": { - "description": "Represents a chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk", - "properties": { - "chunkId": { - "description": "ID of the chunk.", - "type": "string" - }, - "content": { - "description": "Text content of the chunk.", - "type": "string" - }, - "pageFooters": { - "description": "Page footers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter" - }, - "type": "array" - }, - "pageHeaders": { - "description": "Page headers associated with the chunk.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader" - }, - "type": "array" - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the chunk." - }, - "sourceBlockIds": { - "description": "Unused.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter": { - "description": "Represents the page footer associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the footer." - }, - "text": { - "description": "Footer in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader": { - "description": "Represents the page header associated with the chunk.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader", - "properties": { - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "description": "Page span of the header." - }, - "text": { - "description": "Header in text format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan": { - "description": "Represents where the chunk starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan", - "properties": { - "pageEnd": { - "description": "Page where chunk ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where chunk starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout": { - "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayout", - "properties": { - "blocks": { - "description": "List of blocks in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock": { - "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock", - "properties": { - "blockId": { - "description": "ID of the block.", - "type": "string" - }, - "listBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "description": "Block consisting of list content/structure." - }, - "pageSpan": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "description": "Page span of the block." - }, - "tableBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "description": "Block consisting of table content/structure." - }, - "textBlock": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "description": "Block consisting of text content." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { - "description": "Represents a list type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", - "properties": { - "listEntries": { - "description": "List entries that constitute a list block.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" - }, - "type": "array" - }, - "type": { - "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { - "description": "Represents an entry in the list.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", - "properties": { - "blocks": { - "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { - "description": "Represents where the block starts and ends in the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", - "properties": { - "pageEnd": { - "description": "Page where block ends in the document.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "Page where block starts in the document.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { - "description": "Represents a table type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", - "properties": { - "bodyRows": { - "description": "Body rows containing main table content.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - }, - "caption": { - "description": "Table caption/title.", - "type": "string" - }, - "headerRows": { - "description": "Header rows at the top of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { - "description": "Represents a cell in a table row.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", - "properties": { - "blocks": { - "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { - "description": "Represents a row in a table.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", - "properties": { - "cells": { - "description": "A table row is a list of table cells.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { - "description": "Represents a text type block.", - "id": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", - "properties": { - "blocks": { - "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock" - }, - "type": "array" - }, - "text": { - "description": "Text content stored in the block.", - "type": "string" - }, - "type": { - "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntity": { - "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntity", - "properties": { - "confidence": { - "description": "Optional. Confidence of detected Schema entity. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "id": { - "description": "Optional. Canonical id. This will be a unique value in the entity list for this document.", - "type": "string" - }, - "mentionId": { - "description": "Optional. Deprecated. Use `id` field instead.", - "type": "string" - }, - "mentionText": { - "description": "Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.", - "type": "string" - }, - "normalizedValue": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", - "description": "Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types." - }, - "pageAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor", - "description": "Optional. Represents the provenance of this entity wrt. the location on the page where it was found." - }, - "properties": { - "description": "Optional. Entities can be nested to form a hierarchical data structure representing the content in the document.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentEntity" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "description": "Optional. The history of this annotation." - }, - "redacted": { - "description": "Optional. Whether the entity will be redacted for de-identification purposes.", - "type": "boolean" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Optional. Provenance of the entity. Text anchor indexing into the Document.text." - }, - "type": { - "description": "Required. Entity type from a schema e.g. `Address`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue": { - "description": "Parsed and normalized entity value.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue", - "properties": { - "addressValue": { - "$ref": "GoogleTypePostalAddress", - "description": "Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto" - }, - "booleanValue": { - "description": "Boolean value. Can be used for entities with binary values, or for checkboxes.", - "type": "boolean" - }, - "dateValue": { - "$ref": "GoogleTypeDate", - "description": "Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto" - }, - "datetimeValue": { - "$ref": "GoogleTypeDateTime", - "description": "DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto" - }, - "floatValue": { - "description": "Float value.", - "format": "float", - "type": "number" - }, - "integerValue": { - "description": "Integer value.", - "format": "int32", - "type": "integer" - }, - "moneyValue": { - "$ref": "GoogleTypeMoney", - "description": "Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto" - }, - "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" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentEntityRelation": { - "description": "Relationship between Entities.", - "id": "GoogleCloudDocumentaiV1beta2DocumentEntityRelation", - "properties": { - "objectId": { - "description": "Object entity id.", - "type": "string" - }, - "relation": { - "description": "Relationship description.", - "type": "string" - }, - "subjectId": { - "description": "Subject entity id.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentLabel": { - "description": "Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both.", - "id": "GoogleCloudDocumentaiV1beta2DocumentLabel", - "properties": { - "automlModel": { - "description": "Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id}/locations/{location-id}/models/{model-id}`", - "type": "string" - }, - "confidence": { - "description": "Confidence score between 0 and 1 for label assignment.", - "format": "float", - "type": "number" - }, - "name": { - "description": "Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPage": { - "description": "A page in a Document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPage", - "properties": { - "blocks": { - "description": "A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageBlock" - }, - "type": "array" - }, - "detectedBarcodes": { - "description": "A list of detected barcodes.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "dimension": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDimension", - "description": "Physical dimension of the page." - }, - "formFields": { - "description": "A list of visually detected form fields on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageFormField" - }, - "type": "array" - }, - "image": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImage", - "description": "Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned." - }, - "imageQualityScores": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores", - "description": "Image quality scores." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the page." - }, - "lines": { - "description": "A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLine" - }, - "type": "array" - }, - "pageNumber": { - "description": "1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing.", - "format": "int32", - "type": "integer" - }, - "paragraphs": { - "description": "A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this page." - }, - "symbols": { - "description": "A list of visually detected symbols on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol" - }, - "type": "array" - }, - "tables": { - "description": "A list of visually detected tables on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTable" - }, - "type": "array" - }, - "tokens": { - "description": "A list of visually detected tokens on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageToken" - }, - "type": "array" - }, - "transforms": { - "description": "Transformation matrices that were applied to the original document image to produce Page.image.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix" - }, - "type": "array" - }, - "visualElements": { - "description": "A list of detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageAnchor": { - "description": "Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchor", - "properties": { - "pageRefs": { - "description": "One or more references to visual page elements", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef": { - "description": "Represents a weak reference to a page element within a document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "description": "Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to." - }, - "confidence": { - "description": "Optional. Confidence of detected page element, if applicable. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "layoutId": { - "deprecated": true, - "description": "Optional. Deprecated. Use PageRef.bounding_poly instead.", - "type": "string" - }, - "layoutType": { - "description": "Optional. The type of the layout element that is being referenced if any.", - "enum": [ - "LAYOUT_TYPE_UNSPECIFIED", - "BLOCK", - "PARAGRAPH", - "LINE", - "TOKEN", - "VISUAL_ELEMENT", - "TABLE", - "FORM_FIELD" - ], - "enumDescriptions": [ - "Layout Unspecified.", - "References a Page.blocks element.", - "References a Page.paragraphs element.", - "References a Page.lines element.", - "References a Page.tokens element.", - "References a Page.visual_elements element.", - "Refrrences a Page.tables element.", - "References a Page.form_fields element." - ], - "type": "string" - }, - "page": { - "description": "Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageBlock": { - "description": "A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageBlock", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Block." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode": { - "description": "A detected barcode.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode", - "properties": { - "barcode": { - "$ref": "GoogleCloudDocumentaiV1beta2Barcode", - "description": "Detailed barcode information of the DetectedBarcode." - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for DetectedBarcode." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage": { - "description": "Detected language for a structural component.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage", - "properties": { - "confidence": { - "description": "Confidence of detected language. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "languageCode": { - "description": "The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageDimension": { - "description": "Dimension for the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageDimension", - "properties": { - "height": { - "description": "Page height.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Dimension unit.", - "type": "string" - }, - "width": { - "description": "Page width.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageFormField": { - "description": "A form field detected on the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageFormField", - "properties": { - "correctedKeyText": { - "description": "Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "correctedValueText": { - "description": "Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction.", - "type": "string" - }, - "fieldName": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc." - }, - "fieldValue": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for the FormField value." - }, - "nameDetectedLanguages": { - "description": "A list of detected languages for name together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "description": "The history of this annotation." - }, - "valueDetectedLanguages": { - "description": "A list of detected languages for value together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "valueType": { - "description": "If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImage": { - "description": "Rendered image contents for this page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImage", - "properties": { - "content": { - "description": "Raw byte content of the image.", - "format": "byte", - "type": "string" - }, - "height": { - "description": "Height of the image in pixels.", - "format": "int32", - "type": "integer" - }, - "mimeType": { - "description": "Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image.", - "type": "string" - }, - "width": { - "description": "Width of the image in pixels.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores": { - "description": "Image quality scores for the page image.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores", - "properties": { - "detectedDefects": { - "description": "A list of detected defects.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect" - }, - "type": "array" - }, - "qualityScore": { - "description": "The overall quality score. Range `[0, 1]` where `1` is perfect quality.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect": { - "description": "Image Quality Defects", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect", - "properties": { - "confidence": { - "description": "Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists.", - "format": "float", - "type": "number" - }, - "type": { - "description": "Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare`", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageLayout": { - "description": "Visual element describing a layout unit on a page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudDocumentaiV1beta2BoundingPoly", - "description": "The bounding polygon for the Layout." - }, - "confidence": { - "description": "Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`.", - "format": "float", - "type": "number" - }, - "orientation": { - "description": "Detected orientation for the Layout.", - "enum": [ - "ORIENTATION_UNSPECIFIED", - "PAGE_UP", - "PAGE_RIGHT", - "PAGE_DOWN", - "PAGE_LEFT" - ], - "enumDescriptions": [ - "Unspecified orientation.", - "Orientation is aligned with page up.", - "Orientation is aligned with page right. Turn the head 90 degrees clockwise from upright to read.", - "Orientation is aligned with page down. Turn the head 180 degrees from upright to read.", - "Orientation is aligned with page left. Turn the head 90 degrees counterclockwise from upright to read." - ], - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageLine": { - "description": "A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageLine", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Line." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageMatrix": { - "description": "Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageMatrix", - "properties": { - "cols": { - "description": "Number of columns in the matrix.", - "format": "int32", - "type": "integer" - }, - "data": { - "description": "The matrix data.", - "format": "byte", - "type": "string" - }, - "rows": { - "description": "Number of rows in the matrix.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageParagraph": { - "description": "A collection of lines that a human would perceive as a paragraph.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageParagraph", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Paragraph." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageSymbol": { - "description": "A detected symbol.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageSymbol", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Symbol." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTable": { - "description": "A table representation similar to HTML table structure.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTable", - "properties": { - "bodyRows": { - "description": "Body rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow" - }, - "type": "array" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "headerRows": { - "description": "Header rows of the table.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Table." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this table." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell": { - "description": "A cell representation inside the table.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell", - "properties": { - "colSpan": { - "description": "How many columns this cell spans.", - "format": "int32", - "type": "integer" - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for TableCell." - }, - "rowSpan": { - "description": "How many rows this cell spans.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow": { - "description": "A row of table cells.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow", - "properties": { - "cells": { - "description": "Cells that make up this row.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageToken": { - "description": "A detected token.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageToken", - "properties": { - "detectedBreak": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak", - "description": "Detected break at the end of a Token." - }, - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for Token." - }, - "provenance": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "deprecated": true, - "description": "The history of this annotation." - }, - "styleInfo": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", - "description": "Text style attributes." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak": { - "description": "Detected break at the end of a Token.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak", - "properties": { - "type": { - "description": "Detected break type.", - "enum": [ - "TYPE_UNSPECIFIED", - "SPACE", - "WIDE_SPACE", - "HYPHEN" - ], - "enumDescriptions": [ - "Unspecified break type.", - "A single whitespace.", - "A wider whitespace.", - "A hyphen that indicates that a token has been split across lines." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo": { - "description": "Font and other text style attributes.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the background." - }, - "bold": { - "description": "Whether the text is bold (equivalent to font_weight is at least `700`).", - "type": "boolean" - }, - "fontSize": { - "description": "Font size in points (`1` point is `¹⁄₇₂` inches).", - "format": "int32", - "type": "integer" - }, - "fontType": { - "description": "Name or style of the font.", - "type": "string" - }, - "fontWeight": { - "description": "TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`.", - "format": "int32", - "type": "integer" - }, - "handwritten": { - "description": "Whether the text is handwritten.", - "type": "boolean" - }, - "italic": { - "description": "Whether the text is italic.", - "type": "boolean" - }, - "letterSpacing": { - "description": "Letter spacing in points.", - "format": "double", - "type": "number" - }, - "pixelFontSize": { - "description": "Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`.", - "format": "double", - "type": "number" - }, - "smallcaps": { - "description": "Whether the text is in small caps. This feature is not supported yet.", - "type": "boolean" - }, - "strikeout": { - "description": "Whether the text is strikethrough. This feature is not supported yet.", - "type": "boolean" - }, - "subscript": { - "description": "Whether the text is a subscript. This feature is not supported yet.", - "type": "boolean" - }, - "superscript": { - "description": "Whether the text is a superscript. This feature is not supported yet.", - "type": "boolean" - }, - "textColor": { - "$ref": "GoogleTypeColor", - "description": "Color of the text." - }, - "underlined": { - "description": "Whether the text is underlined.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement": { - "description": "Detected non-text visual elements e.g. checkbox, signature etc. on the page.", - "id": "GoogleCloudDocumentaiV1beta2DocumentPageVisualElement", - "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage" - }, - "type": "array" - }, - "layout": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentPageLayout", - "description": "Layout for VisualElement." - }, - "type": { - "description": "Type of the VisualElement.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentProvenance": { - "description": "Structure to identify provenance relationships between annotations in different revisions.", - "id": "GoogleCloudDocumentaiV1beta2DocumentProvenance", - "properties": { - "id": { - "deprecated": true, - "description": "The Id of this operation. Needs to be unique within the scope of the revision.", - "format": "int32", - "type": "integer" - }, - "parents": { - "description": "References to the original elements that are replaced.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent" - }, - "type": "array" - }, - "revision": { - "deprecated": true, - "description": "The index of the revision that produced this element.", - "format": "int32", - "type": "integer" - }, - "type": { - "description": "The type of provenance operation.", - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "ADD", - "REMOVE", - "UPDATE", - "REPLACE", - "EVAL_REQUESTED", - "EVAL_APPROVED", - "EVAL_SKIPPED" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - true, - true, - true - ], - "enumDescriptions": [ - "Operation type unspecified. If no operation is specified a provenance entry is simply used to match against a `parent`.", - "Add an element.", - "Remove an element identified by `parent`.", - "Updates any fields within the given provenance scope of the message. It overwrites the fields rather than replacing them. Use this when you want to update a field value of an entity without also updating all the child properties.", - "Currently unused. Replace an element identified by `parent`.", - "Deprecated. Request human review for the element identified by `parent`.", - "Deprecated. Element is reviewed and approved at human review, confidence will be set to 1.0.", - "Deprecated. Element is skipped in the validation process." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent": { - "description": "The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations.", - "id": "GoogleCloudDocumentaiV1beta2DocumentProvenanceParent", - "properties": { - "id": { - "deprecated": true, - "description": "The id of the parent provenance.", - "format": "int32", - "type": "integer" - }, - "index": { - "description": "The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision.", - "format": "int32", - "type": "integer" - }, - "revision": { - "description": "The index of the index into current revision's parent_ids list.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentRevision": { - "description": "Contains past or forward revisions of this document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentRevision", - "properties": { - "agent": { - "description": "If the change was made by a person specify the name or id of that person.", - "type": "string" - }, - "createTime": { - "description": "The time that the revision was created, internally generated by doc proto storage at the time of create.", - "format": "google-datetime", - "type": "string" - }, - "humanReview": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview", - "description": "Human Review information of this revision." - }, - "id": { - "description": "Id of the revision, internally generated by doc proto storage. Unique within the context of the document.", - "type": "string" - }, - "parent": { - "deprecated": true, - "description": "The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "parentIds": { - "description": "The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field.", - "items": { - "type": "string" - }, - "type": "array" - }, - "processor": { - "description": "If the annotation was made by processor identify the processor by its resource name.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview": { - "description": "Human Review information of the document.", - "id": "GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview", - "properties": { - "state": { - "description": "Human review state. e.g. `requested`, `succeeded`, `rejected`.", - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentShardInfo": { - "description": "For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.", - "id": "GoogleCloudDocumentaiV1beta2DocumentShardInfo", - "properties": { - "shardCount": { - "description": "Total number of shards.", - "format": "int64", - "type": "string" - }, - "shardIndex": { - "description": "The 0-based index of this shard.", - "format": "int64", - "type": "string" - }, - "textOffset": { - "description": "The index of the first character in Document.text in the overall document global text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentStyle": { - "description": "Annotation for common text style attributes. This adheres to CSS conventions as much as possible.", - "id": "GoogleCloudDocumentaiV1beta2DocumentStyle", - "properties": { - "backgroundColor": { - "$ref": "GoogleTypeColor", - "description": "Text background color." - }, - "color": { - "$ref": "GoogleTypeColor", - "description": "Text color." - }, - "fontFamily": { - "description": "Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp", - "type": "string" - }, - "fontSize": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", - "description": "Font size." - }, - "fontWeight": { - "description": "[Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`.", - "type": "string" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Text anchor indexing into the Document.text." - }, - "textDecoration": { - "description": "[Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. ", - "type": "string" - }, - "textStyle": { - "description": "[Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize": { - "description": "Font size with unit.", - "id": "GoogleCloudDocumentaiV1beta2DocumentStyleFontSize", - "properties": { - "size": { - "description": "Font size for the text.", - "format": "float", - "type": "number" - }, - "unit": { - "description": "Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`).", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextAnchor": { - "description": "Text reference indexing into the Document.text.", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "properties": { - "content": { - "description": "Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields.", - "type": "string" - }, - "textSegments": { - "description": "The text segments from the Document.text.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment": { - "description": "A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment", - "properties": { - "endIndex": { - "description": "TextSegment half open end UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - }, - "startIndex": { - "description": "TextSegment start UTF-8 char index in the Document.text.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2DocumentTextChange": { - "description": "This message is used for text changes aka. OCR corrections.", - "id": "GoogleCloudDocumentaiV1beta2DocumentTextChange", - "properties": { - "changedText": { - "description": "The text that replaces the text identified in the `text_anchor`.", - "type": "string" - }, - "provenance": { - "deprecated": true, - "description": "The history of this annotation.", - "items": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentProvenance" - }, - "type": "array" - }, - "textAnchor": { - "$ref": "GoogleCloudDocumentaiV1beta2DocumentTextAnchor", - "description": "Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2GcsDestination": { - "description": "The Google Cloud Storage location where the output file will be written to.", - "id": "GoogleCloudDocumentaiV1beta2GcsDestination", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2GcsSource": { - "description": "The Google Cloud Storage location where the input file will be read from.", - "id": "GoogleCloudDocumentaiV1beta2GcsSource", - "properties": { - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2InputConfig": { - "description": "The desired input location and metadata.", - "id": "GoogleCloudDocumentaiV1beta2InputConfig", - "properties": { - "contents": { - "description": "Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method.", - "format": "byte", - "type": "string" - }, - "gcsSource": { - "$ref": "GoogleCloudDocumentaiV1beta2GcsSource", - "description": "The Google Cloud Storage location to read the input from. This must be a single file." - }, - "mimeType": { - "description": "Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2NormalizedVertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1.", - "id": "GoogleCloudDocumentaiV1beta2NormalizedVertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "float", - "type": "number" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2OperationMetadata": { - "description": "Contains metadata for the BatchProcessDocuments operation.", - "id": "GoogleCloudDocumentaiV1beta2OperationMetadata", - "properties": { - "createTime": { - "description": "The creation time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The state of the current batch processing.", - "enum": [ - "STATE_UNSPECIFIED", - "ACCEPTED", - "WAITING", - "RUNNING", - "SUCCEEDED", - "CANCELLED", - "FAILED" - ], - "enumDescriptions": [ - "The default value. This value is used if the state is omitted.", - "Request is received.", - "Request operation is waiting for scheduling.", - "Request is being processed.", - "The batch processing completed successfully.", - "The batch processing was cancelled.", - "The batch processing has failed." - ], - "type": "string" - }, - "stateMessage": { - "description": "A message providing more details about the current state of processing.", - "type": "string" - }, - "updateTime": { - "description": "The last update time of the operation.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2OutputConfig": { - "description": "The desired output location and metadata.", - "id": "GoogleCloudDocumentaiV1beta2OutputConfig", - "properties": { - "gcsDestination": { - "$ref": "GoogleCloudDocumentaiV1beta2GcsDestination", - "description": "The Google Cloud Storage location to write the output to." - }, - "pagesPerShard": { - "description": "The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse": { - "description": "Response to a single document processing request.", - "id": "GoogleCloudDocumentaiV1beta2ProcessDocumentResponse", - "properties": { - "inputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2InputConfig", - "description": "Information about the input file. This is the same as the corresponding input config in the request." - }, - "outputConfig": { - "$ref": "GoogleCloudDocumentaiV1beta2OutputConfig", - "description": "The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects." - } - }, - "type": "object" - }, - "GoogleCloudDocumentaiV1beta2Vertex": { - "description": "A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image.", - "id": "GoogleCloudDocumentaiV1beta2Vertex", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate (starts from the top of the image).", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "GoogleCloudDocumentaiV1beta3Barcode": { "description": "Encodes the detailed information of a barcode.", "id": "GoogleCloudDocumentaiV1beta3Barcode", @@ -7945,6 +4597,10 @@ }, "type": "array" }, + "description": { + "description": "The description of the entity type. Could be used to provide more information about the entity type for model calls.", + "type": "string" + }, "displayName": { "description": "User defined name for the type.", "type": "string" @@ -7989,6 +4645,10 @@ "description": "Defines properties that can be part of the entity type.", "id": "GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty", "properties": { + "description": { + "description": "The description of the property. Could be used to provide more information about the property for model calls.", + "type": "string" + }, "displayName": { "description": "User defined name for the property.", "type": "string" diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index 9d11d7715a..370415faca 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -1758,7 +1758,7 @@ "type": "integer" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, and `title_natural`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.", + "description": "A comma-separated list of sort keys. Valid keys are: * `createdDate`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `lastViewedByMeDate`: The last time the file was viewed by the user. * `modifiedByMeDate`: The last time the file was modified by the user. * `modifiedDate`: The last time the file was modified by anyone. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeDate`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `title`: The title of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `title_natural`: The title of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedDate desc,title`. Note that there's a current limitation for users with approximately one million files in which the requested sort order is ignored.", "location": "query", "type": "string" }, @@ -3869,7 +3869,7 @@ } } }, - "revision": "20240809", + "revision": "20240914", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index a1a37c14f4..2cedcda7fe 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -1145,6 +1145,42 @@ "https://www.googleapis.com/auth/drive.file" ] }, + "download": { + "description": "Downloads content of a file. Operations are valid for 24 hours from the time of creation.", + "flatPath": "files/{fileId}/download", + "httpMethod": "POST", + "id": "drive.files.download", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "Required. The ID of the file to download.", + "location": "path", + "required": true, + "type": "string" + }, + "mimeType": { + "description": "Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.", + "location": "query", + "type": "string" + }, + "revisionId": { + "description": "Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported.", + "location": "query", + "type": "string" + } + }, + "path": "files/{fileId}/download", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, "emptyTrash": { "description": "Permanently deletes all of the user's trashed files.", "flatPath": "files/trash", @@ -1360,7 +1396,7 @@ "type": "boolean" }, "orderBy": { - "description": "A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name.", + "description": "A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`.", "location": "query", "type": "string" }, @@ -1668,6 +1704,111 @@ } } }, + "operation": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "operation/{name}:cancel", + "httpMethod": "POST", + "id": "drive.operation.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "operation/{name}:cancel" + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "operation/{name}", + "httpMethod": "DELETE", + "id": "drive.operation.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "operation/{name}" + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "operations/{name}", + "httpMethod": "GET", + "id": "drive.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "operations/{name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.meet.readonly", + "https://www.googleapis.com/auth/drive.readonly" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "operations", + "httpMethod": "GET", + "id": "drive.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "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": "operations", + "response": { + "$ref": "ListOperationsResponse" + } + } + } + }, "permissions": { "methods": { "create": { @@ -2523,7 +2664,7 @@ } } }, - "revision": "20240809", + "revision": "20240914", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -4207,6 +4348,24 @@ }, "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" + }, "ModifyLabelsRequest": { "description": "A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.", "id": "ModifyLabelsRequest", @@ -4243,6 +4402,41 @@ }, "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" + }, "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. 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", @@ -4575,6 +4769,33 @@ }, "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" + }, "TeamDrive": { "description": "Deprecated: use the drive collection instead.", "id": "TeamDrive", diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 4012801659..8b5da455c3 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -710,6 +710,279 @@ } } }, + "enrollments": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:getIamPolicy", + "httpMethod": "GET", + "id": "eventarc.projects.locations.enrollments.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/[^/]+/enrollments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:setIamPolicy", + "httpMethod": "POST", + "id": "eventarc.projects.locations.enrollments.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/[^/]+/enrollments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/enrollments/{enrollmentsId}:testIamPermissions", + "httpMethod": "POST", + "id": "eventarc.projects.locations.enrollments.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/[^/]+/enrollments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "googleApiSources": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:getIamPolicy", + "httpMethod": "GET", + "id": "eventarc.projects.locations.googleApiSources.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/[^/]+/googleApiSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:setIamPolicy", + "httpMethod": "POST", + "id": "eventarc.projects.locations.googleApiSources.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/[^/]+/googleApiSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/googleApiSources/{googleApiSourcesId}:testIamPermissions", + "httpMethod": "POST", + "id": "eventarc.projects.locations.googleApiSources.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/[^/]+/googleApiSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "messageBuses": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:getIamPolicy", + "httpMethod": "GET", + "id": "eventarc.projects.locations.messageBuses.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/[^/]+/messageBuses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:setIamPolicy", + "httpMethod": "POST", + "id": "eventarc.projects.locations.messageBuses.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/[^/]+/messageBuses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/messageBuses/{messageBusesId}:testIamPermissions", + "httpMethod": "POST", + "id": "eventarc.projects.locations.messageBuses.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/[^/]+/messageBuses/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -833,6 +1106,97 @@ } } }, + "pipelines": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:getIamPolicy", + "httpMethod": "GET", + "id": "eventarc.projects.locations.pipelines.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/[^/]+/pipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:setIamPolicy", + "httpMethod": "POST", + "id": "eventarc.projects.locations.pipelines.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/[^/]+/pipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/pipelines/{pipelinesId}:testIamPermissions", + "httpMethod": "POST", + "id": "eventarc.projects.locations.pipelines.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/[^/]+/pipelines/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "providers": { "methods": { "get": { @@ -1197,7 +1561,7 @@ } } }, - "revision": "20240524", + "revision": "20240913", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/factchecktools-v1alpha1.json b/discovery/factchecktools-v1alpha1.json index 9f14c9b8f2..81f3a1c6f6 100644 --- a/discovery/factchecktools-v1alpha1.json +++ b/discovery/factchecktools-v1alpha1.json @@ -4,9 +4,6 @@ "scopes": { "https://www.googleapis.com/auth/factchecktools": { "description": "Read, create, update, and delete your ClaimReview data." - }, - "https://www.googleapis.com/auth/userinfo.email": { - "description": "See your primary Google Account email address" } } } @@ -220,8 +217,7 @@ "$ref": "GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage" }, "scopes": [ - "https://www.googleapis.com/auth/factchecktools", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/factchecktools" ] }, "delete": { @@ -246,8 +242,7 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ - "https://www.googleapis.com/auth/factchecktools", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/factchecktools" ] }, "get": { @@ -272,8 +267,7 @@ "$ref": "GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage" }, "scopes": [ - "https://www.googleapis.com/auth/factchecktools", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/factchecktools" ] }, "list": { @@ -316,8 +310,7 @@ "$ref": "GoogleFactcheckingFactchecktoolsV1alpha1ListClaimReviewMarkupPagesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/factchecktools", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/factchecktools" ] }, "update": { @@ -345,14 +338,13 @@ "$ref": "GoogleFactcheckingFactchecktoolsV1alpha1ClaimReviewMarkupPage" }, "scopes": [ - "https://www.googleapis.com/auth/factchecktools", - "https://www.googleapis.com/auth/userinfo.email" + "https://www.googleapis.com/auth/factchecktools" ] } } } }, - "revision": "20240626", + "revision": "20240929", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/discovery/file-v1.json b/discovery/file-v1.json index 6718a32f9c..576e7ee5b2 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -902,7 +902,7 @@ } } }, - "revision": "20240821", + "revision": "20240905", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1140,6 +1140,18 @@ }, "type": "object" }, + "FixedIOPS": { + "description": "Fixed IOPS (input/output operations per second) parameters.", + "id": "FixedIOPS", + "properties": { + "maxReadIops": { + "description": "Required. Maximum raw read IOPS.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1415,10 +1427,27 @@ }, "type": "object" }, + "IOPSPerTB": { + "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", + "id": "IOPSPerTB", + "properties": { + "maxReadIopsPerTb": { + "description": "Required. Maximum read IOPS per TiB.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Instance": { "description": "A Filestore instance.", "id": "Instance", "properties": { + "configurablePerformanceEnabled": { + "description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.", + "readOnly": true, + "type": "boolean" + }, "createTime": { "description": "Output only. The time when the instance was created.", "format": "google-datetime", @@ -1471,6 +1500,15 @@ }, "type": "array" }, + "performanceConfig": { + "$ref": "PerformanceConfig", + "description": "Optional. Used to configure performance." + }, + "performanceLimits": { + "$ref": "PerformanceLimits", + "description": "Output only. Used for getting performance limits.", + "readOnly": true + }, "protocol": { "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.", "enum": [ @@ -1975,6 +2013,52 @@ }, "type": "object" }, + "PerformanceConfig": { + "description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).", + "id": "PerformanceConfig", + "properties": { + "fixedIops": { + "$ref": "FixedIOPS", + "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." + }, + "iopsPerTb": { + "$ref": "IOPSPerTB", + "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." + } + }, + "type": "object" + }, + "PerformanceLimits": { + "description": "The enforced performance limits, calculated from the instance's performance configuration.", + "id": "PerformanceLimits", + "properties": { + "maxReadIops": { + "description": "Output only. The max read IOPS.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxReadThroughputBps": { + "description": "Output only. The max read throughput in bytes per second.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxWriteIops": { + "description": "Output only. The max write IOPS.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxWriteThroughputBps": { + "description": "Output only. The max write throughput in bytes per second.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 1beeeb63c7..22b3110e59 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -502,7 +502,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\"", + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * \"description\" * \"directory_services\" * \"file_shares\" * \"labels\" * \"performance_config\" * \"deletion_protection_enabled\" * \"deletion_protection_reason\"", "format": "google-fieldmask", "location": "query", "type": "string" @@ -520,7 +520,7 @@ ] }, "promoteReplica": { - "description": "Promote an standby instance (replica).", + "description": "Promote the standby instance (replica).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:promoteReplica", "httpMethod": "POST", "id": "file.projects.locations.instances.promoteReplica", @@ -1069,7 +1069,7 @@ } } }, - "revision": "20240716", + "revision": "20240905", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1205,7 +1205,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" } }, @@ -1318,6 +1318,18 @@ }, "type": "object" }, + "FixedIOPS": { + "description": "Fixed IOPS (input/output operations per second) parameters.", + "id": "FixedIOPS", + "properties": { + "maxReadIops": { + "description": "Required. Maximum raw read IOPS.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1593,6 +1605,18 @@ }, "type": "object" }, + "IOPSPerTB": { + "description": "IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB).", + "id": "IOPSPerTB", + "properties": { + "maxReadIopsPerTb": { + "description": "Required. Maximum read IOPS per TiB.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -1608,12 +1632,25 @@ "readOnly": true, "type": "string" }, + "configurablePerformanceEnabled": { + "description": "Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field.", + "readOnly": true, + "type": "boolean" + }, "createTime": { "description": "Output only. The time when the instance was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "deletionProtectionEnabled": { + "description": "Optional. Indicates whether the instance is protected against deletion.", + "type": "boolean" + }, + "deletionProtectionReason": { + "description": "Optional. The reason for enabling deletion protection.", + "type": "string" + }, "description": { "description": "The description of the instance (2048 characters or less).", "type": "string" @@ -1671,6 +1708,15 @@ }, "type": "array" }, + "performanceConfig": { + "$ref": "PerformanceConfig", + "description": "Optional. Used to configure performance." + }, + "performanceLimits": { + "$ref": "PerformanceLimits", + "description": "Output only. Used for getting performance limits.", + "readOnly": true + }, "protocol": { "description": "Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`.", "enum": [ @@ -1687,7 +1733,7 @@ }, "replication": { "$ref": "Replication", - "description": "Optional. Replicaition configuration." + "description": "Optional. Replication configuration." }, "satisfiesPzi": { "description": "Output only. Reserved for future use.", @@ -1757,7 +1803,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" }, "tier": { @@ -2018,11 +2064,11 @@ "type": "object" }, "ManagedActiveDirectoryConfig": { - "description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory.", + "description": "ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD).", "id": "ManagedActiveDirectoryConfig", "properties": { "computer": { - "description": "Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.", + "description": "Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `.", "type": "string" }, "domain": { @@ -2236,6 +2282,52 @@ }, "type": "object" }, + "PerformanceConfig": { + "description": "Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively).", + "id": "PerformanceConfig", + "properties": { + "fixedIops": { + "$ref": "FixedIOPS", + "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." + }, + "iopsPerTb": { + "$ref": "IOPSPerTB", + "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." + } + }, + "type": "object" + }, + "PerformanceLimits": { + "description": "The enforced performance limits, calculated from the instance's performance configuration.", + "id": "PerformanceLimits", + "properties": { + "maxReadIops": { + "description": "Output only. The max read IOPS.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxReadThroughputBps": { + "description": "Output only. The max read throughput in bytes per second.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxWriteIops": { + "description": "Output only. The max write IOPS.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maxWriteThroughputBps": { + "description": "Output only. The max write throughput in bytes per second.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", @@ -2296,7 +2388,7 @@ "id": "Replication", "properties": { "replicas": { - "description": "Replicas configuration on the instance. For now, only a single replica config is supported.", + "description": "Replication configuration for the replica instance associated with this instance. Only a single replica is supported.", "items": { "$ref": "ReplicaConfig" }, @@ -2311,8 +2403,8 @@ ], "enumDescriptions": [ "Role not set.", - "The instance is a Active replication member, functions as the replication source instance.", - "The instance is a Standby replication member, functions as the replication destination instance." + "The instance is the `ACTIVE` replication member, functions as the replication source instance.", + "The instance is the `STANDBY` replication member, functions as the replication destination instance." ], "type": "string" } @@ -2509,7 +2601,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", + "description": "Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\"", "type": "object" } }, diff --git a/discovery/firebase-v1beta1.json b/discovery/firebase-v1beta1.json index e199b35308..6b0e107cba 100644 --- a/discovery/firebase-v1beta1.json +++ b/discovery/firebase-v1beta1.json @@ -1324,7 +1324,7 @@ } } }, - "revision": "20230920", + "revision": "20240913", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -2343,10 +2343,23 @@ "description": "Immutable. A user-assigned unique identifier for the `FirebaseProject`.", "type": "string" }, + "projectNumber": { + "description": "Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Google Cloud or third-party services.", + "readOnly": true, + "type": "string" + }, + "realtimeDatabaseUrl": { + "description": "Optional. Duplicate field for the URL of the default RTDB instances (if there is one) that uses the same field name as the unified V2 config file format. We wanted to make a single config file format for all the app platforms (Android, iOS and web) and we had to pick consistent names for all the fields since there was some varience between the platforms. If the request asks for the V2 format we will populate this field instead of realtime_database_instance_uri.", + "type": "string" + }, "storageBucket": { "deprecated": true, "description": "**DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.", "type": "string" + }, + "version": { + "description": "Version of the config specification.", + "type": "string" } }, "type": "object" diff --git a/discovery/firebaseappcheck-v1.json b/discovery/firebaseappcheck-v1.json index af417cfe54..7c131260b9 100644 --- a/discovery/firebaseappcheck-v1.json +++ b/discovery/firebaseappcheck-v1.json @@ -1370,7 +1370,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)", + "description": "Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1433,7 +1433,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)", + "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1661,7 +1661,7 @@ } } }, - "revision": "20240708", + "revision": "20240930", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -1681,11 +1681,11 @@ "type": "object" }, "GoogleFirebaseAppcheckV1AppCheckToken": { - "description": "Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.", + "description": "Encapsulates an *App Check token*, which are used to access backend services protected by App Check.", "id": "GoogleFirebaseAppcheckV1AppCheckToken", "properties": { "token": { - "description": "The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK.", + "description": "The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.", "type": "string" }, "ttl": { @@ -2277,7 +2277,7 @@ "type": "object" }, "GoogleFirebaseAppcheckV1ResourcePolicy": { - "description": "App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration.", + "description": "App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.", "id": "GoogleFirebaseAppcheckV1ResourcePolicy", "properties": { "enforcementMode": { @@ -2303,7 +2303,7 @@ "type": "string" }, "targetResource": { - "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", + "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", "type": "string" }, "updateTime": { @@ -2351,7 +2351,7 @@ "type": "string" }, "name": { - "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)", + "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)", "type": "string" } }, @@ -2379,7 +2379,7 @@ "properties": { "service": { "$ref": "GoogleFirebaseAppcheckV1Service", - "description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore)" + "description": "Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS)" }, "updateMask": { "description": "Required. A comma-separated list of names of fields in the Service to update. Example: `enforcement_mode`.", diff --git a/discovery/firebaseappcheck-v1beta.json b/discovery/firebaseappcheck-v1beta.json index f9db05bebf..c855c8c977 100644 --- a/discovery/firebaseappcheck-v1beta.json +++ b/discovery/firebaseappcheck-v1beta.json @@ -1595,7 +1595,7 @@ ], "parameters": { "name": { - "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)", + "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", "location": "path", "pattern": "^projects/[^/]+/services/[^/]+$", "required": true, @@ -1823,7 +1823,7 @@ } } }, - "revision": "20240528", + "revision": "20240930", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1betaAppAttestConfig": { @@ -1843,16 +1843,16 @@ "type": "object" }, "GoogleFirebaseAppcheckV1betaAppCheckToken": { - "description": "Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check.", + "description": "Encapsulates an *App Check token*, which are used to access backend services protected by App Check.", "id": "GoogleFirebaseAppcheckV1betaAppCheckToken", "properties": { "attestationToken": { "deprecated": true, - "description": "An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.", + "description": "The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.", "type": "string" }, "token": { - "description": "An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check.", + "description": "The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.", "type": "string" }, "ttl": { @@ -2519,7 +2519,7 @@ "type": "object" }, "GoogleFirebaseAppcheckV1betaResourcePolicy": { - "description": "App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration.", + "description": "App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.", "id": "GoogleFirebaseAppcheckV1betaResourcePolicy", "properties": { "enforcementMode": { @@ -2545,7 +2545,7 @@ "type": "string" }, "targetResource": { - "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", + "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", "type": "string" }, "updateTime": { @@ -2597,7 +2597,7 @@ "type": "string" }, "name": { - "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform)", + "description": "Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS)", "type": "string" }, "updateTime": { diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index daaa28613f..2b53fa39bb 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -448,6 +448,31 @@ "resources": { "tests": { "methods": { + "cancel": { + "description": "Abort automated test run on release.", + "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests/{testsId}:cancel", + "httpMethod": "GET", + "id": "firebaseappdistribution.projects.apps.releases.tests.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`", + "location": "path", + "pattern": "^projects/[^/]+/apps/[^/]+/releases/[^/]+/tests/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:cancel", + "response": { + "$ref": "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Run automated test(s) on release.", "flatPath": "v1alpha/projects/{projectsId}/apps/{appsId}/releases/{releasesId}/tests", @@ -465,7 +490,7 @@ "type": "string" }, "releaseTestId": { - "description": "Optional. The ID to use for the test, which will become the final component of the tests's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated.", + "description": "Optional. The ID to use for the test, which will become the final component of the test's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated.", "location": "query", "type": "string" } @@ -585,7 +610,7 @@ } } }, - "revision": "20240726", + "revision": "20241004", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "AndroidxCrawlerOutputPoint": { @@ -874,6 +899,12 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse": { + "description": "The (empty) response message for `CancelReleaseTest`.", + "id": "GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse", + "properties": {}, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": { "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest", "properties": { @@ -943,7 +974,8 @@ "NOT_INSTALLED", "UNABLE_TO_CRAWL", "DEVICE_OUT_OF_MEMORY", - "FAILED_AI_STEP" + "FAILED_AI_STEP", + "TIMED_OUT" ], "enumDescriptions": [ "Reason unspecified.", @@ -951,7 +983,8 @@ "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "If the app could not be crawled (possibly because the app did not start).", "If the device ran out of memory during the test.", - "At least one AI step failed." + "At least one AI step failed.", + "The crawl reached the time limit before the test could be completed." ], "readOnly": true, "type": "string" @@ -1438,6 +1471,25 @@ "name": { "description": "The name of the release test resource. Format: `projects/{project_number}/apps/{app_id}/releases/{release_id}/tests/{test_id}`", "type": "string" + }, + "testState": { + "description": "Output only. The state of the release test.", + "enum": [ + "TEST_STATE_UNSPECIFIED", + "IN_PROGRESS", + "PASSED", + "FAILED", + "INCONCLUSIVE" + ], + "enumDescriptions": [ + "Test state unspecified.", + "The test is in progress.", + "The test has passed.", + "The test has failed.", + "The test was inconclusive." + ], + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/discovery/firebasedataconnect-v1beta.json b/discovery/firebasedataconnect-v1beta.json new file mode 100644 index 0000000000..1a8ef744ea --- /dev/null +++ b/discovery/firebasedataconnect-v1beta.json @@ -0,0 +1,1831 @@ +{ + "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": "", + "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:v1beta", + "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": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1beta/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "firebasedataconnect.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+parent}/services", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Service.", + "flatPath": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "Service" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Services in a given project and location.", + "flatPath": "v1beta/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": "v1beta/{+parent}/services", + "response": { + "$ref": "ListServicesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Service.", + "flatPath": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+parent}/connectors", + "request": { + "$ref": "Connector" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Connector.", + "flatPath": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeMutation": { + "description": "Execute a predefined mutation in a Connector.", + "flatPath": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "Connector" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Connectors in a given project and location.", + "flatPath": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Schema.", + "flatPath": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+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": "v1beta/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": "v1beta/{+name}", + "request": { + "$ref": "Schema" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + } + } + }, + "revision": "20240924", + "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.", + "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.", + "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" + }, + "schemaValidation": { + "description": "Optional. Configure how much Postgresql schema validation to perform. Default to `STRICT` if not specified.", + "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": "v1beta", + "version_module": true +} \ No newline at end of file diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 2cd463a3ed..a5054ab7f5 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -206,7 +206,7 @@ } } }, - "revision": "20240821", + "revision": "20241003", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -312,6 +312,11 @@ "readOnly": true, "type": "integer" }, + "logprobsResult": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResult", + "description": "Output only. Log-likelihood scores for the response tokens and top tokens", + "readOnly": true + }, "safetyRatings": { "description": "Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.", "items": { @@ -406,6 +411,10 @@ }, "type": "array" }, + "generationConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", + "description": "Optional. Generation config that the model will use to generate the response." + }, "instances": { "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { @@ -448,6 +457,30 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig": { + "description": "Describes the options to customize dynamic retrieval.", + "id": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig", + "properties": { + "dynamicThreshold": { + "description": "Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used.", + "format": "float", + "type": "number" + }, + "mode": { + "description": "The mode of the predictor to be used in dynamic retrieval.", + "enum": [ + "MODE_UNSPECIFIED", + "MODE_DYNAMIC" + ], + "enumDescriptions": [ + "Always trigger retrieval.", + "Run retrieval only when system decides it is necessary." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FileData": { "description": "URI based data.", "id": "GoogleCloudAiplatformV1beta1FileData", @@ -573,6 +606,13 @@ "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", "description": "Optional. Generation config." }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.", + "type": "object" + }, "safetySettings": { "description": "Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.", "items": { @@ -610,6 +650,11 @@ "readOnly": true, "type": "array" }, + "modelVersion": { + "description": "Output only. The model version used to generate the response.", + "readOnly": true, + "type": "string" + }, "promptFeedback": { "$ref": "GoogleCloudAiplatformV1beta1GenerateContentResponsePromptFeedback", "description": "Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.", @@ -693,6 +738,10 @@ "description": "Generation config.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", "properties": { + "audioTimestamp": { + "description": "Optional. If enabled, audio timestamp will be included in the request to the model.", + "type": "boolean" + }, "candidateCount": { "description": "Optional. Number of candidates to generate.", "format": "int32", @@ -703,6 +752,11 @@ "format": "float", "type": "number" }, + "logprobs": { + "description": "Optional. Logit probabilities.", + "format": "int32", + "type": "integer" + }, "maxOutputTokens": { "description": "Optional. The maximum number of output tokens to generate per message.", "format": "int32", @@ -713,6 +767,10 @@ "format": "float", "type": "number" }, + "responseLogprobs": { + "description": "Optional. If true, export the logprobs results in response.", + "type": "boolean" + }, "responseMimeType": { "description": "Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature.", "type": "string" @@ -807,7 +865,12 @@ "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", - "properties": {}, + "properties": { + "dynamicRetrievalConfig": { + "$ref": "GoogleCloudAiplatformV1beta1DynamicRetrievalConfig", + "description": "Specifies the dynamic retrieval configuration for the given source." + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1GroundingChunk": { @@ -873,6 +936,11 @@ }, "type": "array" }, + "retrievalMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1RetrievalMetadata", + "description": "Optional. Output only. Retrieval metadata.", + "readOnly": true + }, "retrievalQueries": { "description": "Optional. Queries executed by the retrieval tools.", "items": { @@ -921,6 +989,62 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1LogprobsResult": { + "description": "Logprobs Result", + "id": "GoogleCloudAiplatformV1beta1LogprobsResult", + "properties": { + "chosenCandidates": { + "description": "Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" + }, + "type": "array" + }, + "topCandidates": { + "description": "Length = total number of decoding steps.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1LogprobsResultCandidate": { + "description": "Candidate for the logprobs token and score.", + "id": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate", + "properties": { + "logProbability": { + "description": "The candidate's log probability.", + "format": "float", + "type": "number" + }, + "token": { + "description": "The candidate's token string value.", + "type": "string" + }, + "tokenId": { + "description": "The candidate's token id value.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates": { + "description": "Candidates with top log probabilities at each decoding step.", + "id": "GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates", + "properties": { + "candidates": { + "description": "Sorted by log probability in descending order.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1LogprobsResultCandidate" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Part": { "description": "A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes.", "id": "GoogleCloudAiplatformV1beta1Part", @@ -972,6 +1096,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RetrievalMetadata": { + "description": "Metadata related to retrieval in the grounding flow.", + "id": "GoogleCloudAiplatformV1beta1RetrievalMetadata", + "properties": { + "googleSearchDynamicRetrievalScore": { + "description": "Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SafetyRating": { "description": "Safety rating corresponding to the generated content.", "id": "GoogleCloudAiplatformV1beta1SafetyRating", @@ -988,14 +1124,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "readOnly": true, "type": "string" @@ -1064,14 +1202,16 @@ "HARM_CATEGORY_HATE_SPEECH", "HARM_CATEGORY_DANGEROUS_CONTENT", "HARM_CATEGORY_HARASSMENT", - "HARM_CATEGORY_SEXUALLY_EXPLICIT" + "HARM_CATEGORY_SEXUALLY_EXPLICIT", + "HARM_CATEGORY_CIVIC_INTEGRITY" ], "enumDescriptions": [ "The harm category is unspecified.", "The harm category is hate speech.", "The harm category is dangerous content.", "The harm category is harassment.", - "The harm category is sexually explicit content." + "The harm category is sexually explicit content.", + "The harm category is civic integrity." ], "type": "string" }, @@ -1096,14 +1236,16 @@ "BLOCK_LOW_AND_ABOVE", "BLOCK_MEDIUM_AND_ABOVE", "BLOCK_ONLY_HIGH", - "BLOCK_NONE" + "BLOCK_NONE", + "OFF" ], "enumDescriptions": [ "Unspecified harm block threshold.", "Block low threshold and above (i.e. block more).", "Block medium threshold and above.", "Block only high threshold (i.e. block less).", - "Block none." + "Block none.", + "Turn off the safety filter." ], "type": "string" } @@ -1114,6 +1256,13 @@ "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": { + "anyOf": { + "description": "Optional. The value should be validated against any (one or more) of the subschemas in the list.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Schema" + }, + "type": "array" + }, "default": { "description": "Optional. Default value of the data.", "type": "any" @@ -1123,7 +1272,7 @@ "type": "string" }, "enum": { - "description": "Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]}", + "description": "Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:[\"EAST\", NORTH\", \"SOUTH\", \"WEST\"]} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:[\"101\", \"201\", \"301\"]}", "items": { "type": "string" }, @@ -1196,6 +1345,13 @@ "description": "Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.", "type": "object" }, + "propertyOrdering": { + "description": "Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties.", + "items": { + "type": "string" + }, + "type": "array" + }, "required": { "description": "Optional. Required properties of Type.OBJECT.", "items": { @@ -1283,7 +1439,7 @@ "id": "GoogleCloudAiplatformV1beta1Tool", "properties": { "functionDeclarations": { - "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.", + "description": "Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.", "items": { "$ref": "GoogleCloudAiplatformV1beta1FunctionDeclaration" }, diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 5597eabfed..963529a5d4 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1682,6 +1682,11 @@ "parent" ], "parameters": { + "filter": { + "description": "An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `database_uid` (supports `=` only)", + "location": "query", + "type": "string" + }, "parent": { "description": "Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.", "location": "path", @@ -1706,7 +1711,7 @@ } } }, - "revision": "20240822", + "revision": "20240904", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2525,6 +2530,17 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1BackupSource": { + "description": "Information about a backup that was used to restore a database.", + "id": "GoogleFirestoreAdminV1BackupSource", + "properties": { + "backup": { + "description": "The resource name of the backup that was used to restore this database. Format: `projects/{project}/locations/{location}/backups/{backup}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata": { "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.", "id": "GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata", @@ -2762,6 +2778,11 @@ "readOnly": true, "type": "string" }, + "sourceInfo": { + "$ref": "GoogleFirestoreAdminV1SourceInfo", + "description": "Output only. Information about the provenance of this database.", + "readOnly": true + }, "type": { "description": "The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.", "enum": [ @@ -3521,6 +3542,21 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1SourceInfo": { + "description": "Information about the provenance of this database.", + "id": "GoogleFirestoreAdminV1SourceInfo", + "properties": { + "backup": { + "$ref": "GoogleFirestoreAdminV1BackupSource", + "description": "If set, this database was restored from the specified backup (or a snapshot thereof)." + }, + "operation": { + "description": "The associated long-running operation. This field may not be set after the operation has completed. Format: `projects/{project}/databases/{database}/operations/{operation}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1Stats": { "description": "Backup specific statistics.", "id": "GoogleFirestoreAdminV1Stats", diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index 2f44f99f3d..1586c0474b 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -2111,7 +2111,7 @@ } } }, - "revision": "20240825", + "revision": "20240920", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4164,6 +4164,22 @@ }, "type": "object" }, + "IdentityServiceDiagnosticInterface": { + "description": "Configuration options for the AIS diagnostic interface.", + "id": "IdentityServiceDiagnosticInterface", + "properties": { + "enabled": { + "description": "Determines whether to enable the diagnostic interface.", + "type": "boolean" + }, + "expirationTime": { + "description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4198,8 +4214,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { + "diagnosticInterface": { + "$ref": "IdentityServiceDiagnosticInterface", + "description": "Configuration options for the AIS diagnostic interface." + }, "sessionDuration": { - "description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", + "description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6082,8 +6102,11 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT_SAFE", "CONFIG_APPLY_INTERNAL_ERROR", "CONFIG_VALIDATION_ERROR", "CONFIG_VALIDATION_WARNING", @@ -6101,7 +6124,11 @@ "QUOTA_EXCEEDED_SERVICE_LB_POLICIES", "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", - "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS" + "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "MODERNIZATION_SCHEDULED", + "MODERNIZATION_IN_PROGRESS", + "MODERNIZATION_COMPLETED", + "MODERNIZATION_ABORTED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6112,8 +6139,11 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", + "User is using deprecated ControlPlaneManagement and they have not yet set Management.", + "User is using deprecated ControlPlaneManagement and they have already set Management.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", "Configuration failed to be applied due to being invalid.", "Encountered configuration(s) with possible unintended behavior or invalid configuration. These configs may not have been applied.", @@ -6131,7 +6161,11 @@ "ServiceLBPolicy quota exceeded error code.", "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", - "NetworkEndpointGroup quota exceeded error code." + "NetworkEndpointGroup quota exceeded error code.", + "Modernization is scheduled for a cluster.", + "Modernization is in progress for a cluster.", + "Modernization is completed for a cluster.", + "Modernization is aborted for a cluster." ], "type": "string" }, diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 31d90efa2f..51257ea0f4 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -793,6 +793,41 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateExclusivityManifest": { + "description": "GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub. The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateExclusivityManifest", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.generateExclusivityManifest", + "parameterOrder": [ + "name" + ], + "parameters": { + "crManifest": { + "description": "Optional. The YAML manifest of the membership CR retrieved by `kubectl get memberships membership`. Leave empty if the resource does not exist.", + "location": "query", + "type": "string" + }, + "crdManifest": { + "description": "Optional. The YAML manifest of the membership CRD retrieved by `kubectl get customresourcedefinitions membership`. Leave empty if the resource does not exist.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:generateExclusivityManifest", + "response": { + "$ref": "GenerateExclusivityManifestResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the details of a Membership.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}", @@ -1063,6 +1098,41 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "validateExclusivity": { + "description": "ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership resource.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/memberships:validateExclusivity", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.validateExclusivity", + "parameterOrder": [ + "parent" + ], + "parameters": { + "crManifest": { + "description": "Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist.", + "location": "query", + "type": "string" + }, + "intendedMembership": { + "description": "Required. The intended membership name under the `parent`. This method only does validation in anticipation of a CreateMembership call with the same name.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/memberships:validateExclusivity", + "response": { + "$ref": "ValidateExclusivityResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2185,7 +2255,7 @@ } } }, - "revision": "20240825", + "revision": "20240920", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4351,6 +4421,21 @@ }, "type": "object" }, + "GenerateExclusivityManifestResponse": { + "description": "The response of the exclusivity artifacts manifests for the client to apply.", + "id": "GenerateExclusivityManifestResponse", + "properties": { + "crManifest": { + "description": "The YAML manifest of the membership CR to apply if a new version of the CR is available. Empty if no update needs to be applied.", + "type": "string" + }, + "crdManifest": { + "description": "The YAML manifest of the membership CRD to apply if a newer version of the CRD is available. Empty if no update needs to be applied.", + "type": "string" + } + }, + "type": "object" + }, "GenerateMembershipRBACRoleBindingYAMLResponse": { "description": "Response for GenerateRBACRoleBindingYAML.", "id": "GenerateMembershipRBACRoleBindingYAMLResponse", @@ -4477,6 +4562,22 @@ }, "type": "object" }, + "IdentityServiceDiagnosticInterface": { + "description": "Configuration options for the AIS diagnostic interface.", + "id": "IdentityServiceDiagnosticInterface", + "properties": { + "enabled": { + "description": "Determines whether to enable the diagnostic interface.", + "type": "boolean" + }, + "expirationTime": { + "description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4511,8 +4612,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { + "diagnosticInterface": { + "$ref": "IdentityServiceDiagnosticInterface", + "description": "Configuration options for the AIS diagnostic interface." + }, "sessionDuration": { - "description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", + "description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6606,8 +6711,11 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT_SAFE", "CONFIG_APPLY_INTERNAL_ERROR", "CONFIG_VALIDATION_ERROR", "CONFIG_VALIDATION_WARNING", @@ -6625,7 +6733,11 @@ "QUOTA_EXCEEDED_SERVICE_LB_POLICIES", "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", - "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS" + "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "MODERNIZATION_SCHEDULED", + "MODERNIZATION_IN_PROGRESS", + "MODERNIZATION_COMPLETED", + "MODERNIZATION_ABORTED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6636,8 +6748,11 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", + "User is using deprecated ControlPlaneManagement and they have not yet set Management.", + "User is using deprecated ControlPlaneManagement and they have already set Management.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", "Configuration failed to be applied due to being invalid.", "Encountered configuration(s) with possible unintended behavior or invalid configuration. These configs may not have been applied.", @@ -6655,7 +6770,11 @@ "ServiceLBPolicy quota exceeded error code.", "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", - "NetworkEndpointGroup quota exceeded error code." + "NetworkEndpointGroup quota exceeded error code.", + "Modernization is scheduled for a cluster.", + "Modernization is in progress for a cluster.", + "Modernization is completed for a cluster.", + "Modernization is aborted for a cluster." ], "type": "string" }, @@ -7043,6 +7162,17 @@ }, "type": "object" }, + "ValidateExclusivityResponse": { + "description": "The response of exclusivity artifacts validation result status.", + "id": "ValidateExclusivityResponse", + "properties": { + "status": { + "$ref": "GoogleRpcStatus", + "description": "The validation result. * `OK` means that exclusivity is validated, assuming the manifest produced by GenerateExclusivityManifest is successfully applied. * `ALREADY_EXISTS` means that the Membership CRD is already owned by another Hub. See `status.message` for more information." + } + }, + "type": "object" + }, "ValidationResult": { "description": "ValidationResults are results set by each validator running during ValidateCreateMembership.", "id": "ValidationResult", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index fbf3cc4207..fa18eeae39 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -2111,7 +2111,7 @@ } } }, - "revision": "20240825", + "revision": "20240920", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -4258,6 +4258,22 @@ }, "type": "object" }, + "IdentityServiceDiagnosticInterface": { + "description": "Configuration options for the AIS diagnostic interface.", + "id": "IdentityServiceDiagnosticInterface", + "properties": { + "enabled": { + "description": "Determines whether to enable the diagnostic interface.", + "type": "boolean" + }, + "expirationTime": { + "description": "Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "IdentityServiceGoogleConfig": { "description": "Configuration for the Google Plugin Auth flow.", "id": "IdentityServiceGoogleConfig", @@ -4292,8 +4308,12 @@ "description": "Holds non-protocol-related configuration options.", "id": "IdentityServiceIdentityServiceOptions", "properties": { + "diagnosticInterface": { + "$ref": "IdentityServiceDiagnosticInterface", + "description": "Configuration options for the AIS diagnostic interface." + }, "sessionDuration": { - "description": "Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service.", + "description": "Determines the lifespan of STS tokens issued by Anthos Identity Service.", "format": "google-duration", "type": "string" } @@ -6245,8 +6265,11 @@ "NODEPOOL_WORKLOAD_IDENTITY_FEDERATION_REQUIRED", "CNI_INSTALLATION_FAILED", "CNI_POD_UNSCHEDULABLE", + "CLUSTER_HAS_ZERO_NODES", "UNSUPPORTED_MULTIPLE_CONTROL_PLANES", "VPCSC_GA_SUPPORTED", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT", + "DEPRECATED_SPEC_CONTROL_PLANE_MANAGEMENT_SAFE", "CONFIG_APPLY_INTERNAL_ERROR", "CONFIG_VALIDATION_ERROR", "CONFIG_VALIDATION_WARNING", @@ -6264,7 +6287,11 @@ "QUOTA_EXCEEDED_SERVICE_LB_POLICIES", "QUOTA_EXCEEDED_HTTP_FILTERS", "QUOTA_EXCEEDED_TCP_FILTERS", - "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS" + "QUOTA_EXCEEDED_NETWORK_ENDPOINT_GROUPS", + "MODERNIZATION_SCHEDULED", + "MODERNIZATION_IN_PROGRESS", + "MODERNIZATION_COMPLETED", + "MODERNIZATION_ABORTED" ], "enumDescriptions": [ "Default Unspecified code", @@ -6275,8 +6302,11 @@ "Nodepool workload identity federation required error code", "CNI installation failed error code", "CNI pod unschedulable error code", + "Cluster has zero node code", "Multiple control planes unsupported error code", "VPC-SC GA is supported for this control plane.", + "User is using deprecated ControlPlaneManagement and they have not yet set Management.", + "User is using deprecated ControlPlaneManagement and they have already set Management.", "Configuration (Istio/k8s resources) failed to apply due to internal error.", "Configuration failed to be applied due to being invalid.", "Encountered configuration(s) with possible unintended behavior or invalid configuration. These configs may not have been applied.", @@ -6294,7 +6324,11 @@ "ServiceLBPolicy quota exceeded error code.", "HTTPFilter quota exceeded error code.", "TCPFilter quota exceeded error code.", - "NetworkEndpointGroup quota exceeded error code." + "NetworkEndpointGroup quota exceeded error code.", + "Modernization is scheduled for a cluster.", + "Modernization is in progress for a cluster.", + "Modernization is completed for a cluster.", + "Modernization is aborted for a cluster." ], "type": "string" }, diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 4b96d501a5..61c81fad1e 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -3341,6 +3341,116 @@ "resources": { "fhir": { "methods": { + "Binary-create": { + "description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the FHIR store this resource belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/fhir/Binary", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-read": { + "description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Binary resource to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-update": { + "description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", + "httpMethod": "PUT", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource to update.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-vread": { + "description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Binary resource version to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "Patient-everything": { "description": "Retrieves a Patient resource and resources related to that patient. Implements the FHIR extended operation Patient-everything ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/patient-operations.html#everything), [STU3](http://hl7.org/implement/standards/fhir/STU3/patient-operations.html#everything), [R4](http://hl7.org/implement/standards/fhir/R4/patient-operations.html#everything)). On success, the response body contains a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The resources in scope for the response are: * The patient resource itself. * All the resources directly referenced by the patient resource. * Resources directly referencing the patient resource that meet the inclusion criteria. The inclusion criteria are based on the membership rules in the patient compartment definition ([DSTU2](http://hl7.org/fhir/DSTU2/compartment-patient.html), [STU3](http://www.hl7.org/fhir/stu3/compartmentdefinition-patient.html), [R4](http://hl7.org/fhir/R4/compartmentdefinition-patient.html)), which details the eligible resource types and referencing search parameters. For samples that show how to call `Patient-everything`, see [Getting all patient compartment resources](https://cloud.google.com/healthcare/docs/how-tos/fhir-resources#getting_all_patient_compartment_resources).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Patient/{PatientId}/$everything", @@ -4673,7 +4783,7 @@ } } }, - "revision": "20240819", + "revision": "20240910", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5476,7 +5586,7 @@ }, "notificationConfig": { "$ref": "NotificationConfig", - "description": "Notification destination for new DICOM instances. Supplied by the client." + "description": "Optional. Notification destination for new DICOM instances. Supplied by the client." }, "streamConfigs": { "description": "Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination.", @@ -5853,15 +5963,15 @@ "id": "FhirNotificationConfig", "properties": { "pubsubTopic": { - "description": "The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).", + "description": "Optional. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging).", "type": "string" }, "sendFullResource": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", + "description": "Optional. Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", "type": "boolean" }, "sendPreviousResourceOnDelete": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "description": "Optional. Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -5886,7 +5996,7 @@ "type": "string" }, "defaultSearchHandlingStrict": { - "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", + "description": "Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -5898,7 +6008,7 @@ "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", + "description": "Optional. Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -5918,14 +6028,14 @@ "description": "Deprecated. Use `notification_configs` instead. If non-empty, publish all resource modifications of this FHIR store to this destination. The Pub/Sub message attributes contain a map with a string describing the action that has triggered the notification. For example, \"action\":\"CreateResource\"." }, "notificationConfigs": { - "description": "Specifies where and whether to send notifications upon changes to a FHIR store.", + "description": "Optional. Specifies where and whether to send notifications upon changes to a FHIR store.", "items": { "$ref": "FhirNotificationConfig" }, "type": "array" }, "streamConfigs": { - "description": "A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.", + "description": "Optional. A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination.", "items": { "$ref": "StreamConfig" }, @@ -6220,19 +6330,19 @@ "id": "GoogleCloudHealthcareV1FhirBigQueryDestination", "properties": { "datasetUri": { - "description": "BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.", + "description": "Optional. BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`.", "type": "string" }, "force": { - "description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", + "description": "Optional. The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { "$ref": "SchemaConfig", - "description": "The configuration for the exported BigQuery schema." + "description": "Optional. The configuration for the exported BigQuery schema." }, "writeDisposition": { - "description": "Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.", + "description": "Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored.", "enum": [ "WRITE_DISPOSITION_UNSPECIFIED", "WRITE_EMPTY", @@ -6332,7 +6442,7 @@ "id": "Hl7V2NotificationConfig", "properties": { "filter": { - "description": "Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`.", + "description": "Optional. Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `\"query text\"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `\"Comment = great\"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `>`, `>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = \"ADT\"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < \"2017-01-02\"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < \"2017-01-02T00:00:00-05:00\"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < \"2017-01-02T00:00:00-05:00\"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = \"ABC\"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId(\"123456\", \"MRN\")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels.\"priority\"=\"high\"`. The operator `:*` can be used to assert the existence of a label. For example, `labels.\"priority\":*`.", "type": "string" }, "pubsubTopic": { @@ -6358,7 +6468,7 @@ "type": "string" }, "notificationConfigs": { - "description": "A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client.", + "description": "Optional. A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client.", "items": { "$ref": "Hl7V2NotificationConfig" }, @@ -6366,10 +6476,10 @@ }, "parserConfig": { "$ref": "ParserConfig", - "description": "The configuration for the parser. It determines how the server parses the messages." + "description": "Optional. The configuration for the parser. It determines how the server parses the messages." }, "rejectDuplicateMessage": { - "description": "Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.", + "description": "Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection.", "type": "boolean" } }, @@ -7067,12 +7177,12 @@ "id": "ParserConfig", "properties": { "allowNullHeader": { - "description": "Determines whether messages with no header are allowed.", + "description": "Optional. Determines whether messages with no header are allowed.", "type": "boolean" }, "schema": { "$ref": "SchemaPackage", - "description": "Schemas used to parse messages in this store, if schematized parsing is desired." + "description": "Optional. Schemas used to parse messages in this store, if schematized parsing is desired." }, "segmentTerminator": { "description": "Byte(s) to use as the segment terminator. If this is unset, '\\r' is used as segment terminator, matching the HL7 version 2 specification.", @@ -7514,18 +7624,18 @@ "id": "SchemaPackage", "properties": { "ignoreMinOccurs": { - "description": "Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.", + "description": "Optional. Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent.", "type": "boolean" }, "schemas": { - "description": "Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message.", + "description": "Optional. Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message.", "items": { "$ref": "Hl7SchemaConfig" }, "type": "array" }, "schematizedParsingType": { - "description": "Determines how messages that fail to parse are handled.", + "description": "Optional. Determines how messages that fail to parse are handled.", "enum": [ "SCHEMATIZED_PARSING_TYPE_UNSPECIFIED", "SOFT_FAIL", @@ -7539,14 +7649,14 @@ "type": "string" }, "types": { - "description": "Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message.", + "description": "Optional. Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message.", "items": { "$ref": "Hl7TypesConfig" }, "type": "array" }, "unexpectedSegmentHandling": { - "description": "Determines how unexpected segments (segments not matched to the schema) are handled.", + "description": "Optional. Determines how unexpected segments (segments not matched to the schema) are handled.", "enum": [ "UNEXPECTED_SEGMENT_HANDLING_MODE_UNSPECIFIED", "FAIL", @@ -7775,14 +7885,14 @@ "properties": { "bigqueryDestination": { "$ref": "GoogleCloudHealthcareV1FhirBigQueryDestination", - "description": "The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, \"Patient\", \"Observation\". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." + "description": "Optional. The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, \"Patient\", \"Observation\". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, "deidentifiedStoreDestination": { "$ref": "DeidentifiedStoreDestination", "description": "The destination FHIR store for de-identified resources. After this field is added, all subsequent creates/updates/patches to the source store will be de-identified using the provided configuration and applied to the destination store. Importing resources to the source store will not trigger the streaming. If the source store already contains resources when this option is enabled, those resources will not be copied to the destination store unless they are subsequently updated. This may result in invalid references in the destination store. Before adding this config, you must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enable_update_create to true. The destination store must have disable_referential_integrity set to true. If a resource cannot be de-identified, errors will be logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging))." }, "resourceTypes": { - "description": "Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.", + "description": "Optional. Supply a FHIR resource type (such as \"Patient\" or \"Observation\"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store.", "items": { "type": "string" }, diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 6d69dcd8c5..92348cdbc6 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -4078,6 +4078,116 @@ "resources": { "fhir": { "methods": { + "Binary-create": { + "description": "Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the FHIR store this resource belongs to.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/fhir/Binary", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-read": { + "description": "Gets the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-read", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Binary resource to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-update": { + "description": "Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the \"http://hl7.org/fhir/StructureDefinition/data-absent-reason\" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}", + "httpMethod": "PUT", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource to update.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "HttpBody" + }, + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "Binary-vread": { + "description": "Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/Binary/{BinaryId}/_history/{_historyId}", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.fhirStores.fhir.Binary-vread", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Binary resource version to retrieve.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+/fhir/Binary/[^/]+/_history/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "HttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "ConceptMap-search-translate": { "description": "Translates a code from one value set to another by searching for appropriate concept maps. Implements the FHIR standard $translate operation ([DSTU2](https://www.hl7.org/fhir/DSTU2/operation-conceptmap-translate.html), [STU3](https://www.hl7.org/fhir/STU3/operation-conceptmap-translate.html), [R4](https://www.hl7.org/fhir/R4/operation-conceptmap-translate.html)). On success, the response body contains a JSON-encoded representation of a FHIR Parameters resource, which includes the translation result. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/ConceptMap/$translate", @@ -5748,7 +5858,7 @@ } } }, - "revision": "20240819", + "revision": "20240822", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index 322707bf2a..c1d83bd820 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -3188,7 +3188,7 @@ } } }, - "revision": "20240725", + "revision": "20240918", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -3555,7 +3555,7 @@ ], "enumDescriptions": [ "No AttributesType specified.", - "Used to get the user's group claims from the Azure AD identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`." + "Used to get the user's group claims from the Microsoft Entra ID identity provider using configuration provided in ExtraAttributesOAuth2Client and `mail` property of the `microsoft.graph.group` object is used for claim mapping. See https://learn.microsoft.com/en-us/graph/api/resources/group?view=graph-rest-1.0#properties for more details on `microsoft.graph.group` properties. The attributes obtained from idntity provider are mapped to `assertion.groups`." ], "type": "string" }, diff --git a/discovery/iap-v1.json b/discovery/iap-v1.json index b77b906042..fdd061cfab 100644 --- a/discovery/iap-v1.json +++ b/discovery/iap-v1.json @@ -682,7 +682,7 @@ } } }, - "revision": "20240623", + "revision": "20240909", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -741,7 +741,7 @@ }, "policyDelegationSettings": { "$ref": "PolicyDelegationSettings", - "description": "Optional. Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY." + "description": "Optional. Settings to allow google-internal teams to use IAP for apps hosted in a tenant project." }, "reauthSettings": { "$ref": "ReauthSettings", @@ -1188,7 +1188,7 @@ "type": "string" }, "method": { - "description": "Reauth method requested.", + "description": "Optional. Reauth method requested.", "enum": [ "METHOD_UNSPECIFIED", "LOGIN", diff --git a/discovery/index.json b/discovery/index.json index 190031688c..2fa65c7d2e 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -196,21 +196,6 @@ "title": "AdSense Management API", "version": "v2" }, - { - "description": "The AdSense Host API gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.", - "discoveryRestUrl": "https://adsensehost.googleapis.com/$discovery/rest?version=v4.1", - "documentationLink": "https://developers.google.com/adsense/host/index", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "id": "adsensehost:v4.1", - "kind": "discovery#directoryItem", - "name": "adsensehost", - "preferred": true, - "title": "AdSense Host API", - "version": "v4.1" - }, { "description": "", "discoveryRestUrl": "https://adsenseplatform.googleapis.com/$discovery/rest?version=v1alpha", @@ -2631,7 +2616,7 @@ { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/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" @@ -2646,7 +2631,7 @@ { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/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" @@ -2661,7 +2646,7 @@ { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1", - "documentationLink": "https://cloud.google.com/discovery-engine/docs", + "documentationLink": "https://cloud.google.com/generative-ai-app-builder/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" @@ -2763,21 +2748,6 @@ "title": "Google Docs API", "version": "v1" }, - { - "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", - "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta2", - "documentationLink": "https://cloud.google.com/document-ai/docs/", - "icons": { - "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", - "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" - }, - "id": "documentai:v1beta2", - "kind": "discovery#directoryItem", - "name": "documentai", - "preferred": false, - "title": "Cloud Document AI API", - "version": "v1beta2" - }, { "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta3", @@ -3155,6 +3125,21 @@ "title": "Firebase Realtime Database 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=v1beta", + "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:v1beta", + "kind": "discovery#directoryItem", + "name": "firebasedataconnect", + "preferred": true, + "title": "Firebase Data Connect API", + "version": "v1beta" + }, { "description": "Programmatically creates and manages Firebase Dynamic Links.", "discoveryRestUrl": "https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1", @@ -4321,10 +4306,25 @@ "id": "merchantapi:reports_v1beta", "kind": "discovery#directoryItem", "name": "merchantapi", - "preferred": true, + "preferred": false, "title": "Merchant API", "version": "reports_v1beta" }, + { + "description": "Programmatically manage your Merchant Center Accounts.", + "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=reviews_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "merchantapi:reviews_v1beta", + "kind": "discovery#directoryItem", + "name": "merchantapi", + "preferred": true, + "title": "Merchant API", + "version": "reviews_v1beta" + }, { "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1alpha", @@ -4746,6 +4746,21 @@ "title": "On-Demand Scanning API", "version": "v1" }, + { + "description": "The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.", + "discoveryRestUrl": "https://oracledatabase.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/oracle/database/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": "oracledatabase:v1", + "kind": "discovery#directoryItem", + "name": "oracledatabase", + "preferred": true, + "title": "Oracle Database@Google Cloud API", + "version": "v1" + }, { "description": "The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.", "discoveryRestUrl": "https://orgpolicy.googleapis.com/$discovery/rest?version=v2", diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 2eff1752e1..b8a69c7894 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -1196,6 +1196,34 @@ "resources": { "executions": { "methods": { + "cancel": { + "description": "Cancellation of an execution and associated sub-executions. This will not cancel an IN_PROCESS or completed(SUCCESSFUL, FAILED or CANCELLED) executions.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:cancel", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.executions.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/products/{product}/integrations/{integration_id}/executions/{execution_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "download": { "description": "Download the execution.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:download", @@ -1380,6 +1408,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "replay": { + "description": "Re-execute an existing execution, with same request parameters and execution strategy", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:replay", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.executions.replay", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The execution resource name. Format: projects/{gcp_project_id}/locations/{location}/integrations/{integration}/executions/{execution_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:replay", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1699,7 +1755,7 @@ "type": "string" }, "orderBy": { - "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\", \"snapshot_number\" Ascending sort order for \"name\".", + "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last\\_modified\\_time\", \"created\\_time\", and \"snapshot\\_number\". Ascending sort order for `name`.", "location": "query", "type": "string" }, @@ -1848,6 +1904,363 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "testCases": { + "methods": { + "create": { + "description": "Creates a new test case", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this test case will be created. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "testCaseId": { + "description": "Required. Required", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/testCases", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a test case", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.integrations.versions.testCases.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. ID for the test case to be deleted", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "download": { + "description": "Downloads a test case. Retrieves the `TestCase` for a given `test_case_id` and returns the response as a string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:download", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "fileFormat": { + "description": "File format for download request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The test case to download. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:download", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeTest": { + "description": "Executes functional test", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.executeTest", + "parameterOrder": [ + "testCaseName" + ], + "parameters": { + "testCaseName": { + "description": "Required. Test case resource name", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+testCaseName}:executeTest", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a test case", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The ID of the test case to retrieve", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all the test cases that satisfy the filters.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\". Ascending sort order for \"name\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this TestCase was created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. The mask which specifies fields that need to be returned in the TestCases's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/testCases", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListTestCasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listExecutions": { + "description": "Lists the results of all functional test executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executions", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.listExecutions", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: \"parameter_type\" HAS \\\"string\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND test_case_id=\\\"testCaseId\\\"", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The results would be returned in order you specified here. Currently supporting \"last_modified_time\" and \"create_time\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The size of entries in the response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The token returned in the previous response.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource name of the test case execution.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in event execution info will be filled and returned.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "truncateParams": { + "deprecated": true, + "description": "Optional. If true, the service will truncate the params to only keep the first 1000 characters of string params and empty the executions in order to make response smaller. Only works for UI and when the params fields are not filtered out.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}:executions", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a test case", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.integrations.versions.testCases.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto-generated primary key.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask specifying the fields in the above integration that have been modified and need to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "takeoverEditLock": { + "description": "Clear the lock fields and assign them to current user", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:takeoverEditLock", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.takeoverEditLock", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The ID of test case to takeover edit lock. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}/testCases/{test_case_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:takeoverEditLock", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "upload": { + "description": "Uploads a test case. The content can be a previously downloaded test case. Performs the same function as CreateTestCase, but accepts input in a string format, which holds the complete representation of the TestCase content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases:upload", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.upload", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The test case to upload. Format: projects/{project}/locations/{location}/integrations/{integration}/versions/{integration_version}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/testCases:upload", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -2840,7 +3253,7 @@ "type": "string" }, "orderBy": { - "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\", \"snapshot_number\" Ascending sort order for \"name\".", + "description": "The results would be returned in order you specified here. Currently supported sort keys are: Descending sort order for \"last\\_modified\\_time\", \"created\\_time\", and \"snapshot\\_number\". Ascending sort order for `name`.", "location": "query", "type": "string" }, @@ -4084,7 +4497,7 @@ } } }, - "revision": "20240825", + "revision": "20240927", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -8427,7 +8840,7 @@ "type": "object" }, "EnterpriseCrmFrontendsEventbusProtoTriggerConfig": { - "description": "Configuration detail of a trigger. Next available id: 20", + "description": "Configuration detail of a trigger. Next available id: 22", "id": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig", "properties": { "alertConfig": { @@ -8455,6 +8868,13 @@ "description": "Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", "type": "string" }, + "inputVariables": { + "description": "Optional. List of input variables for the api trigger.", + "items": { + "type": "string" + }, + "type": "array" + }, "label": { "description": "The user created label for a particular trigger.", "type": "string" @@ -8473,6 +8893,13 @@ ], "type": "string" }, + "outputVariables": { + "description": "Optional. List of output variables for the api trigger.", + "items": { + "type": "string" + }, + "type": "array" + }, "pauseWorkflowExecutions": { "description": "Optional. If set to true, any upcoming requests for this trigger config will be paused and the executions will be resumed later when the flag is reset. The workflow to which this trigger config belongs has to be in ACTIVE status for the executions to be paused or resumed.", "type": "boolean" @@ -8712,7 +9139,8 @@ "OAUTH2_CLIENT_CREDENTIALS", "SSH_PUBLIC_KEY", "OAUTH2_AUTH_CODE_FLOW", - "GOOGLE_AUTHENTICATION" + "GOOGLE_AUTHENTICATION", + "OAUTH2_AUTH_CODE_FLOW_GOOGLE_MANAGED" ], "enumDescriptions": [ "Authentication type not specified.", @@ -8721,7 +9149,8 @@ "Oauth 2.0 Client Credentials Grant Authentication", "SSH Public Key Authentication", "Oauth 2.0 Authorization Code Flow", - "Google authentication" + "Google authentication", + "Oauth 2.0 Authorization Code Flow with Google Provided OAuth Client" ], "type": "string" }, @@ -8729,6 +9158,10 @@ "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlow", "description": "Oauth2AuthCodeFlow." }, + "oauth2AuthCodeFlowGoogleManaged": { + "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", + "description": "Oauth2AuthCodeFlowGoogleManaged." + }, "oauth2ClientCredentials": { "$ref": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", "description": "Oauth2ClientCredentials." @@ -8790,6 +9223,28 @@ }, "type": "object" }, + "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged": { + "description": "Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details.", + "id": "GoogleCloudConnectorsV1AuthConfigOauth2AuthCodeFlowGoogleManaged", + "properties": { + "authCode": { + "description": "Optional. Authorization code to be exchanged for access and refresh tokens.", + "type": "string" + }, + "redirectUri": { + "description": "Optional. Redirect URI to be provided during the auth code exchange.", + "type": "string" + }, + "scopes": { + "description": "Required. Scopes the connection will request when the user performs the auth code flow.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials": { "description": "Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details.", "id": "GoogleCloudConnectorsV1AuthConfigOauth2ClientCredentials", @@ -8943,6 +9398,10 @@ "$ref": "GoogleCloudConnectorsV1AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." }, + "authOverrideEnabled": { + "description": "Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API.", + "type": "boolean" + }, "billingConfig": { "$ref": "GoogleCloudConnectorsV1BillingConfig", "description": "Output only. Billing config for the connection.", @@ -9243,6 +9702,21 @@ "description": "Output only. The name of shared connector deployment.", "readOnly": true, "type": "string" + }, + "tlsMigrationState": { + "description": "Output only. Status of the TLS migration.", + "enum": [ + "TLS_MIGRATION_STATE_UNSPECIFIED", + "TLS_MIGRATION_NOT_STARTED", + "TLS_MIGRATION_COMPLETED" + ], + "enumDescriptions": [ + "TLS migration state is not specified.", + "TLS migration is in progress.", + "TLS migration is completed." + ], + "readOnly": true, + "type": "string" } }, "type": "object" @@ -9708,6 +10182,87 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaAssertion": { + "description": "An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5", + "id": "GoogleCloudIntegrationsV1alphaAssertion", + "properties": { + "assertionStrategy": { + "description": "The type of assertion to perform.", + "enum": [ + "ASSERTION_STRATEGY_UNSPECIFIED", + "ASSERT_SUCCESSFUL_EXECUTION", + "ASSERT_FAILED_EXECUTION", + "ASSERT_NO_EXECUTION", + "ASSERT_EQUALS", + "ASSERT_NOT_EQUALS", + "ASSERT_CONTAINS", + "ASSERT_CONDITION" + ], + "enumDescriptions": [ + "Unspecified Assertion strategy", + "Test a successful execution", + "Test a failed execution", + "Test that the task was never executed", + "Test the parameter selected is equal to the expected value", + "Test the parameter selected is not equal to the expected value", + "Test the parameter selected contains the configured value", + "Test a specific condition" + ], + "type": "string" + }, + "condition": { + "description": "Optional. Standard filter expression for ASSERT_CONDITION to succeed", + "type": "string" + }, + "parameter": { + "$ref": "GoogleCloudIntegrationsV1alphaEventParameter", + "description": "Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed" + }, + "retryCount": { + "description": "Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaAssertionResult": { + "description": "The result of an assertion.", + "id": "GoogleCloudIntegrationsV1alphaAssertionResult", + "properties": { + "assertion": { + "$ref": "GoogleCloudIntegrationsV1alphaAssertion", + "description": "Assertion that was run." + }, + "failureMessage": { + "description": "Details of the assertion failure", + "type": "string" + }, + "status": { + "description": "Status of assertion to signify if the assertion succeeded or failed", + "enum": [ + "ASSERTION_STATUS_UNSPECIFIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified assertion status", + "Assertion succeeded", + "Assertion failed" + ], + "type": "string" + }, + "taskName": { + "description": "Task name of task where the assertion was run.", + "type": "string" + }, + "taskNumber": { + "description": "Task number of task where the assertion was run.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaAttemptStats": { "description": "Status for the execution attempt.", "id": "GoogleCloudIntegrationsV1alphaAttemptStats", @@ -9882,16 +10437,38 @@ }, "type": "object" }, - "GoogleCloudIntegrationsV1alphaBooleanParameterArray": { - "description": "This message only contains a field of boolean array.", - "id": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", + "GoogleCloudIntegrationsV1alphaBooleanParameterArray": { + "description": "This message only contains a field of boolean array.", + "id": "GoogleCloudIntegrationsV1alphaBooleanParameterArray", + "properties": { + "booleanValues": { + "description": "Boolean array.", + "items": { + "type": "boolean" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCancelExecutionRequest": { + "description": "Request for cancelling an execution.", + "id": "GoogleCloudIntegrationsV1alphaCancelExecutionRequest", + "properties": { + "cancelReason": { + "description": "Optional. Reason for cancelling the execution This is provided by the client requesting the cancellation Platform will not use this field", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaCancelExecutionResponse": { + "description": "Response for cancelling an execution.", + "id": "GoogleCloudIntegrationsV1alphaCancelExecutionResponse", "properties": { - "booleanValues": { - "description": "Boolean array.", - "items": { - "type": "boolean" - }, - "type": "array" + "isCanceled": { + "description": "True if cancellation performed successfully", + "type": "boolean" } }, "type": "object" @@ -10390,6 +10967,17 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse": { + "description": "Response for DownloadTestCase.", + "id": "GoogleCloudIntegrationsV1alphaDownloadTestCaseResponse", + "properties": { + "content": { + "description": "String representation of the test case.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse": { "description": "Response containing all provisioned regions for Connector Platform.", "id": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse", @@ -10548,6 +11136,60 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest": { + "description": "The request for executing a functional test.", + "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest", + "properties": { + "inputParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. Input parameters used by test case execution.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse": { + "description": "The response for executing a functional test.", + "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse", + "properties": { + "assertionResults": { + "description": "Results of each assertions ran during execution of test case.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAssertionResult" + }, + "type": "array" + }, + "executionId": { + "description": "The id of the execution corresponding to this run of integration.", + "type": "string" + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", + "type": "object" + }, + "testExecutionState": { + "description": "State of the test case execution", + "enum": [ + "STATE_UNSPECIFIED", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified state", + "Test case execution passed", + "Test case execution failed" + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaExecution": { "description": "The Execution resource contains detailed information of an individual integration execution.", "id": "GoogleCloudIntegrationsV1alphaExecution", @@ -10641,12 +11283,11 @@ "additionalProperties": { "$ref": "GoogleCloudIntegrationsV1alphaValueType" }, - "description": "Event parameters returned as part of the response.", + "description": "Event parameters returned as part of the response. In the case of error, the `ErrorInfo` field is returned in the following format: { \"ErrorInfo\": { \"message\": String, \"code\": Number } } ", "type": "object" }, "responseParams": { "deprecated": true, - "description": "Event parameters come out as part of the response.", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoParameterEntry" }, @@ -11161,7 +11802,12 @@ "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", - "NON_SERIALIZABLE_OBJECT" + "NON_SERIALIZABLE_OBJECT", + "PROTO_ENUM", + "SERIALIZED_OBJECT_VALUE", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", @@ -11176,7 +11822,12 @@ "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", - "// Non-serializable object (Internal use only)." + "// Non-serializable object (Internal use only).", + "Proto Enum (Internal use only).", + "Serialized object (Internal use only).", + "Proto Enum Array (Internal use only).", + "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ], "type": "string" }, @@ -11753,6 +12404,79 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse": { + "description": "The response for listing the functional test execution data.", + "id": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse", + "properties": { + "executions": { + "description": "The detailed information of requested executions", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaExecution" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The token used to retrieve the next page results.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaListTestCasesResponse": { + "description": "Response for ListTestCases", + "id": "GoogleCloudIntegrationsV1alphaListTestCasesResponse", + "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" + }, + "testCases": { + "description": "The test cases corresponding to the specified filter", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMockConfig": { + "description": "The configuration for mocking of a task during test execution Next available id: 4", + "id": "GoogleCloudIntegrationsV1alphaMockConfig", + "properties": { + "failedExecutions": { + "description": "Optional. Number of times the given task should fail for failure mock strategy", + "format": "int64", + "type": "string" + }, + "mockStrategy": { + "description": "Mockstrategy defines how the particular task should be mocked during test execution", + "enum": [ + "MOCK_STRATEGY_UNSPECIFIED", + "NO_MOCK_STRATEGY", + "SPECIFIC_MOCK_STRATEGY", + "FAILURE_MOCK_STRATEGY", + "SKIP_MOCK_STRATEGY" + ], + "enumDescriptions": [ + "This should never be used to annotate a field", + "Execute actual task", + "Don't execute actual task, instead use the values specified by user for output of the task", + "Don't execute actual task, instead return task failure", + "Don't execute actual task, instead mark it as successful" + ], + "type": "string" + }, + "parameters": { + "description": "Optional. List of key-value pairs for specific mock strategy", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaEventParameter" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaNextTask": { "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", "id": "GoogleCloudIntegrationsV1alphaNextTask", @@ -11995,7 +12719,12 @@ "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", - "NON_SERIALIZABLE_OBJECT" + "NON_SERIALIZABLE_OBJECT", + "PROTO_ENUM", + "SERIALIZED_OBJECT_VALUE", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", @@ -12010,7 +12739,12 @@ "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", - "// Non-serializable object (Internal use only)." + "// Non-serializable object (Internal use only).", + "Proto Enum (Internal use only).", + "Serialized object (Internal use only).", + "Proto Enum Array (Internal use only).", + "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ], "type": "string" }, @@ -12029,7 +12763,12 @@ "JSON_VALUE", "PROTO_VALUE", "PROTO_ARRAY", - "NON_SERIALIZABLE_OBJECT" + "NON_SERIALIZABLE_OBJECT", + "PROTO_ENUM", + "SERIALIZED_OBJECT_VALUE", + "PROTO_ENUM_ARRAY", + "BYTES", + "BYTES_ARRAY" ], "enumDescriptions": [ "Unspecified.", @@ -12044,7 +12783,12 @@ "Json.", "Proto Value (Internal use only).", "Proto Array (Internal use only).", - "// Non-serializable object (Internal use only)." + "// Non-serializable object (Internal use only).", + "Proto Enum (Internal use only).", + "Serialized object (Internal use only).", + "Proto Enum Array (Internal use only).", + "BYTES data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", + "BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields." ], "type": "string" } @@ -12191,6 +12935,40 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaReplayExecutionRequest": { + "description": "Request for replaying an execution Next ID: 3", + "id": "GoogleCloudIntegrationsV1alphaReplayExecutionRequest", + "properties": { + "replayReason": { + "description": "Optional. The user provided reason for replaying the execution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaReplayExecutionResponse": { + "description": "Response for replaying an execution Next ID: 4", + "id": "GoogleCloudIntegrationsV1alphaReplayExecutionResponse", + "properties": { + "executionId": { + "description": "The id of the execution corresponding to this run of integration.", + "type": "string" + }, + "outputParameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "OUTPUT parameters in format of Map. Where Key is the name of the parameter. The parameters would only be present in case of synchrounous execution Note: Name of the system generated parameters are wrapped by backtick(`) to distinguish them from the user defined parameters.", + "type": "object" + }, + "replayedExecutionId": { + "description": "The execution id which is replayed", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest": { "description": "Request for [Suspensions.ResolveSuspensions].", "id": "GoogleCloudIntegrationsV1alphaResolveSuspensionRequest", @@ -12675,6 +13453,12 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest": { + "description": "Request for TakeoverTestCaseEditLock.", + "id": "GoogleCloudIntegrationsV1alphaTakeoverTestCaseEditLockRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaTaskConfig": { "description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.", "id": "GoogleCloudIntegrationsV1alphaTaskConfig", @@ -13038,6 +13822,84 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaTestCase": { + "description": "Defines the functional test case for Application Integration. Next available id: 15", + "id": "GoogleCloudIntegrationsV1alphaTestCase", + "properties": { + "createTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "creatorEmail": { + "description": "Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "databasePersistencePolicy": { + "description": "Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..", + "enum": [ + "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", + "DATABASE_PERSISTENCE_DISABLED", + "DATABASE_PERSISTENCE_ASYNC" + ], + "enumDescriptions": [ + "Enables persistence for all execution data.", + "Disables persistence for all execution data.", + "Asynchronously persist all execution data." + ], + "type": "string" + }, + "description": { + "description": "Optional. Description of the test case.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of test case.", + "type": "string" + }, + "lastModifierEmail": { + "description": "The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "lockHolderEmail": { + "description": "Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "name": { + "description": "Output only. Auto-generated primary key.", + "readOnly": true, + "type": "string" + }, + "testInputParameters": { + "description": "Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" + }, + "type": "array" + }, + "testTaskConfigs": { + "description": "Optional. However, the test case doesn't mock or assert anything without test_task_configs.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTestTaskConfig" + }, + "type": "array" + }, + "triggerConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaTriggerConfig", + "description": "Optional. Auto-generated." + }, + "triggerId": { + "description": "Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case", + "type": "string" + }, + "updateTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest": { "description": "The request for testing an integration.", "id": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest", @@ -13121,6 +13983,36 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaTestTaskConfig": { + "description": "The task mock configuration details and assertions for functional tests. Next available id: 6", + "id": "GoogleCloudIntegrationsV1alphaTestTaskConfig", + "properties": { + "assertions": { + "description": "Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAssertion" + }, + "type": "array" + }, + "mockConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaMockConfig", + "description": "Optional. Defines how to mock the given task during test execution" + }, + "task": { + "description": "Required. This defines in the test case, the task name in integration which will be mocked by this test task config", + "type": "string" + }, + "taskConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaTaskConfig", + "description": "Optional. Auto-generated." + }, + "taskNumber": { + "description": "Required. This defines in the test case, the task in integration which will be mocked by this test task config", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaTriggerConfig": { "description": "Configuration detail of a trigger.", "id": "GoogleCloudIntegrationsV1alphaTriggerConfig", @@ -13144,6 +14036,13 @@ "description": "Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", "type": "string" }, + "inputVariables": { + "description": "Optional. List of input variables for the api trigger.", + "items": { + "type": "string" + }, + "type": "array" + }, "label": { "description": "Optional. The user created label for a particular trigger.", "type": "string" @@ -13162,6 +14061,13 @@ ], "type": "string" }, + "outputVariables": { + "description": "Optional. List of output variables for the api trigger.", + "items": { + "type": "string" + }, + "type": "array" + }, "position": { "$ref": "GoogleCloudIntegrationsV1alphaCoordinate", "description": "Optional. Informs the front-end application where to draw this error catcher config on the UI." @@ -13203,7 +14109,8 @@ "SFDC_CDC_CHANNEL", "CLOUD_SCHEDULER", "INTEGRATION_CONNECTOR_TRIGGER", - "PRIVATE_TRIGGER" + "PRIVATE_TRIGGER", + "CLOUD_PUBSUB" ], "enumDescriptions": [ "Unknown.", @@ -13214,7 +14121,8 @@ "SFDC Channel Trigger for CDC.", "Trigger by Cloud Scheduler job.", "Trigger by Connector Event", - "Trigger for private workflow" + "Trigger for private workflow", + "Trigger by cloud pub/sub for internal ip" ], "type": "string" } @@ -13246,7 +14154,7 @@ "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest", "properties": { "content": { - "description": "The textproto of the integration_version.", + "description": "The textproto of the IntegrationVersion.", "type": "string" }, "fileFormat": { @@ -13313,6 +14221,42 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest": { + "description": "Request for UploadTestCase.", + "id": "GoogleCloudIntegrationsV1alphaUploadTestCaseRequest", + "properties": { + "content": { + "description": "The textproto of the test case.", + "type": "string" + }, + "fileFormat": { + "description": "File format for upload request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse": { + "description": "Response for UploadTestCase.", + "id": "GoogleCloudIntegrationsV1alphaUploadTestCaseResponse", + "properties": { + "testCase": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase", + "description": "The uploaded TestCase" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaUseTemplateRequest": { "description": "Request to Use template", "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequest", diff --git a/discovery/language-v1.json b/discovery/language-v1.json index 297e094461..ae0d3ed06c 100644 --- a/discovery/language-v1.json +++ b/discovery/language-v1.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240310", + "revision": "20240929", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -756,7 +756,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1042,6 +1046,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -1473,7 +1481,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1759,6 +1771,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -2149,7 +2165,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2435,6 +2455,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -3616,6 +3640,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3632,6 +3657,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v1beta2.json b/discovery/language-v1beta2.json index 4cc5240900..9c4ca533dc 100644 --- a/discovery/language-v1beta2.json +++ b/discovery/language-v1beta2.json @@ -246,7 +246,7 @@ } } }, - "revision": "20240225", + "revision": "20240929", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -756,7 +756,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1042,6 +1046,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -1491,7 +1499,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1777,6 +1789,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -2167,7 +2183,11 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2453,6 +2473,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -3634,6 +3658,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3650,6 +3675,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 2ca253270c..8cf36eb865 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240713", + "revision": "20240929", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -426,6 +426,11 @@ "name": { "description": "The name of the category representing the document.", "type": "string" + }, + "severity": { + "description": "Optional. The classifier's severity of the category. This is only present when the ModerateTextRequest.ModelVersion is set to MODEL_VERSION_2, and the corresponding category has a severity score.", + "format": "float", + "type": "number" } }, "type": "object" @@ -576,6 +581,9 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "E2_STANDARD_2", @@ -864,6 +872,9 @@ "", "", "", + "", + "", + "", "" ], "type": "string" @@ -1109,6 +1120,9 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "E2_STANDARD_2", @@ -1397,6 +1411,9 @@ "", "", "", + "", + "", + "", "" ], "type": "string" @@ -1460,6 +1477,20 @@ "document": { "$ref": "Document", "description": "Required. Input document." + }, + "modelVersion": { + "description": "Optional. The model version to use for ModerateText.", + "enum": [ + "MODEL_VERSION_UNSPECIFIED", + "MODEL_VERSION_1", + "MODEL_VERSION_2" + ], + "enumDescriptions": [ + "The default model version.", + "Use the v1 model, this model is used by default when not provided. The v1 model only returns probability (confidence) score for each category.", + "Use the v2 model. The v2 model only returns probability (confidence) score for each category, and returns severity score for a subset of the categories." + ], + "type": "string" } }, "type": "object" @@ -1528,6 +1559,9 @@ "A2_ULTRAGPU_2G", "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", + "A3_HIGHGPU_1G", + "A3_HIGHGPU_2G", + "A3_HIGHGPU_4G", "A3_HIGHGPU_8G", "A3_MEGAGPU_8G", "E2_STANDARD_2", @@ -1816,6 +1850,9 @@ "", "", "", + "", + "", + "", "" ], "type": "string" diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index ae4c3db784..948b584324 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -3027,6 +3027,172 @@ } } }, + "logScopes": { + "methods": { + "create": { + "description": "Creates a log scope.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes", + "httpMethod": "POST", + "id": "logging.folders.locations.logScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "logScopeId": { + "description": "Required. A client-assigned identifier such as \"log-scope\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a log scope.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "DELETE", + "id": "logging.folders.locations.logScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a log scope.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "GET", + "id": "logging.folders.locations.logScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists log scopes.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes", + "httpMethod": "GET", + "id": "logging.folders.locations.logScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" ", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "response": { + "$ref": "ListLogScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a log scope.", + "flatPath": "v2/folders/{foldersId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "PATCH", + "id": "logging.folders.locations.logScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", + "location": "path", + "pattern": "^folders/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -5679,6 +5845,172 @@ } } }, + "logScopes": { + "methods": { + "create": { + "description": "Creates a log scope.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes", + "httpMethod": "POST", + "id": "logging.organizations.locations.logScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "logScopeId": { + "description": "Required. A client-assigned identifier such as \"log-scope\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a log scope.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "DELETE", + "id": "logging.organizations.locations.logScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a log scope.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "GET", + "id": "logging.organizations.locations.logScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists log scopes.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes", + "httpMethod": "GET", + "id": "logging.organizations.locations.logScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" ", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "response": { + "$ref": "ListLogScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a log scope.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "PATCH", + "id": "logging.organizations.locations.logScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -7315,6 +7647,172 @@ } } }, + "logScopes": { + "methods": { + "create": { + "description": "Creates a log scope.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes", + "httpMethod": "POST", + "id": "logging.projects.locations.logScopes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "logScopeId": { + "description": "Required. A client-assigned identifier such as \"log-scope\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent project in which to create the log scope \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" For example:\"projects/my-project/locations/global\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "delete": { + "description": "Deletes a log scope.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "DELETE", + "id": "logging.projects.locations.logScopes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope to delete: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + }, + "get": { + "description": "Gets a log scope.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "GET", + "id": "logging.projects.locations.logScopes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the log scope: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]\" For example:\"projects/my-project/locations/global/logScopes/my-log-scope\"", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "list": { + "description": "Lists log scopes.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes", + "httpMethod": "GET", + "id": "logging.projects.locations.logScopes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource whose log scopes are to be listed: \"projects/[PROJECT_ID]/locations/[LOCATION_ID]\" ", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/logScopes", + "response": { + "$ref": "ListLogScopesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ] + }, + "patch": { + "description": "Updates a log scope.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/logScopes/{logScopesId}", + "httpMethod": "PATCH", + "id": "logging.projects.locations.logScopes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/logScopes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+name}", + "request": { + "$ref": "LogScope" + }, + "response": { + "$ref": "LogScope" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -8424,7 +8922,7 @@ } } }, - "revision": "20240726", + "revision": "20240913", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { @@ -9297,6 +9795,24 @@ }, "type": "object" }, + "ListLogScopesResponse": { + "description": "The response from ListLogScopes. Every project has a _Default log scope that cannot be modified or deleted.", + "id": "ListLogScopesResponse", + "properties": { + "logScopes": { + "description": "A list of log scopes.", + "items": { + "$ref": "LogScope" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", + "type": "string" + } + }, + "type": "object" + }, "ListLogsResponse": { "description": "Result returned from ListLogs.", "id": "ListLogsResponse", @@ -9487,7 +10003,7 @@ "id": "LogBucket", "properties": { "analyticsEnabled": { - "description": "Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.", + "description": "Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.", "type": "boolean" }, "cmekSettings": { @@ -9899,6 +10415,41 @@ }, "type": "object" }, + "LogScope": { + "description": "Describes a group of resources to read log entries from.", + "id": "LogScope", + "properties": { + "createTime": { + "description": "Output only. The creation timestamp of the log scope.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Describes this log scope.The maximum length of the description is 8000 characters.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope", + "readOnly": true, + "type": "string" + }, + "resourceNames": { + "description": "Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.", + "items": { + "type": "string" + }, + "type": "array" + }, + "updateTime": { + "description": "Output only. The last update timestamp of the log scope.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LogSink": { "description": "Describes a sink used to export log entries to one of the following destinations: a Cloud Logging log bucket, a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic, a Cloud project.A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.", "id": "LogSink", @@ -10209,6 +10760,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/looker-v1.json b/discovery/looker-v1.json index 4a72394b92..d961b6e101 100644 --- a/discovery/looker-v1.json +++ b/discovery/looker-v1.json @@ -731,7 +731,7 @@ } } }, - "revision": "20240814", + "revision": "20240910", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -1092,6 +1092,14 @@ "$ref": "EncryptionConfig", "description": "Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance." }, + "fipsEnabled": { + "description": "Optional. Whether FIPS is enabled on the Looker instance.", + "type": "boolean" + }, + "geminiEnabled": { + "description": "Optional. Whether Gemini feature is enabled on the Looker instance or not.", + "type": "boolean" + }, "ingressPrivateIp": { "description": "Output only. Private Ingress IP (IPv4).", "readOnly": true, diff --git a/discovery/memcache-v1.json b/discovery/memcache-v1.json index b9e0eca5a2..c9e6a241e0 100644 --- a/discovery/memcache-v1.json +++ b/discovery/memcache-v1.json @@ -584,7 +584,7 @@ } } }, - "revision": "20240614", + "revision": "20240919", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -605,12 +605,85 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -668,12 +741,35 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "GoogleCloudMemcacheV1LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1LocationMetadata", @@ -1232,6 +1328,131 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1327,6 +1548,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "LocationMetadata", @@ -1616,6 +1895,74 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", @@ -1684,6 +2031,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1711,6 +2078,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -1846,6 +2225,15 @@ }, "type": "object" }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" + }, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, diff --git a/discovery/memcache-v1beta2.json b/discovery/memcache-v1beta2.json index 00e8f9962a..b79d6866b7 100644 --- a/discovery/memcache-v1beta2.json +++ b/discovery/memcache-v1beta2.json @@ -612,7 +612,7 @@ } } }, - "revision": "20240614", + "revision": "20240919", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { @@ -651,12 +651,85 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -714,12 +787,35 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "GoogleCloudMemcacheV1beta2LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "GoogleCloudMemcacheV1beta2LocationMetadata", @@ -1283,6 +1379,131 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1378,6 +1599,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "id": "LocationMetadata", @@ -1672,6 +1951,74 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", @@ -1740,6 +2087,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1767,6 +2134,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -1902,6 +2281,15 @@ }, "type": "object" }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" + }, "ZoneMetadata": { "id": "ZoneMetadata", "properties": {}, diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 3363ee7deb..d4281fb91c 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -126,7 +126,7 @@ ] }, "delete": { - "description": "Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access.", + "description": "Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.", "flatPath": "accounts/v1beta/accounts/{accountsId}", "httpMethod": "DELETE", "id": "merchantapi.accounts.delete", @@ -134,6 +134,11 @@ "name" ], "parameters": { + "force": { + "description": "Optional. If set to `true`, the account is deleted even if it provides services to other accounts or has processed offers.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Required. The name of the account to delete. Format: `accounts/{account}`", "location": "path", @@ -176,7 +181,7 @@ ] }, "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.", + "description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to.", "flatPath": "accounts/v1beta/accounts", "httpMethod": "GET", "id": "merchantapi.accounts.list", @@ -279,6 +284,69 @@ } }, "resources": { + "autofeedSettings": { + "methods": { + "getAutofeedSettings": { + "description": "Retrieves the autofeed settings of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/autofeedSettings", + "httpMethod": "GET", + "id": "merchantapi.accounts.autofeedSettings.getAutofeedSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`", + "location": "path", + "pattern": "^accounts/[^/]+/autofeedSettings$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "AutofeedSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateAutofeedSettings": { + "description": "Updates the autofeed settings of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/autofeedSettings", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.autofeedSettings.updateAutofeedSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`.", + "location": "path", + "pattern": "^accounts/[^/]+/autofeedSettings$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "AutofeedSettings" + }, + "response": { + "$ref": "AutofeedSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, "businessIdentity": { "methods": { "getBusinessIdentity": { @@ -405,13 +473,13 @@ } } }, - "emailpreferences": { + "emailPreferences": { "methods": { "getEmailPreferences": { "description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "GET", - "id": "merchantapi.accounts.emailpreferences.getEmailPreferences", + "id": "merchantapi.accounts.emailPreferences.getEmailPreferences", "parameterOrder": [ "name" ], @@ -436,7 +504,7 @@ "description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "PATCH", - "id": "merchantapi.accounts.emailpreferences.updateEmailPreferences", + "id": "merchantapi.accounts.emailPreferences.updateEmailPreferences", "parameterOrder": [ "name" ], @@ -621,13 +689,8 @@ "required": true, "type": "string" }, - "timeZone.id": { - "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", - "location": "query", - "type": "string" - }, - "timeZone.version": { - "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "timeZone": { + "description": "Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used.", "location": "query", "type": "string" } @@ -1325,7 +1388,7 @@ "parameterOrder": [], "parameters": { "kind": { - "description": "The Kind this terms of service version applies to.", + "description": "Required. The Kind this terms of service version applies to.", "enum": [ "TERMS_OF_SERVICE_KIND_UNSPECIFIED", "MERCHANT_CENTER" @@ -1338,7 +1401,7 @@ "type": "string" }, "regionCode": { - "description": "Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.", + "description": "Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally.", "location": "query", "type": "string" } @@ -1354,24 +1417,9 @@ } } }, - "revision": "20240830", + "revision": "20241004", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { - "AcceptTermsOfService": { - "description": "Reference to a Terms of Service resource.", - "id": "AcceptTermsOfService", - "properties": { - "name": { - "description": "Required. The resource name of the terms of service version.", - "type": "string" - }, - "regionCode": { - "description": "Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or `001` when it applies globally.", - "type": "string" - } - }, - "type": "object" - }, "Accepted": { "description": "Describes the accepted terms of service.", "id": "Accepted", @@ -1429,6 +1477,12 @@ }, "type": "object" }, + "AccountAggregation": { + "description": "`AccountAggregation` payload.", + "id": "AccountAggregation", + "properties": {}, + "type": "object" + }, "AccountIssue": { "description": "An [`AccountIssue`](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account).", "id": "AccountIssue", @@ -1480,8 +1534,8 @@ "id": "AddAccountService", "properties": { "accountAggregation": { - "$ref": "Empty", - "description": "The provider is an aggregator for the account." + "$ref": "AccountAggregation", + "description": "The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation." }, "provider": { "description": "Optional. The provider of the service. Format: `accounts/{account}`", @@ -1517,6 +1571,26 @@ }, "type": "object" }, + "AutofeedSettings": { + "description": "Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.", + "id": "AutofeedSettings", + "properties": { + "eligible": { + "description": "Output only. Determines whether merchant is eligible for being enrolled into an autofeed.", + "readOnly": true, + "type": "boolean" + }, + "enableProducts": { + "description": "Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear.", + "type": "boolean" + }, + "name": { + "description": "Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`.", + "type": "string" + } + }, + "type": "object" + }, "BusinessDayConfig": { "description": "Business days of the warehouse.", "id": "BusinessDayConfig", @@ -1680,16 +1754,12 @@ "description": "Request message for the `CreateAndConfigureAccount` method.", "id": "CreateAndConfigureAccountRequest", "properties": { - "acceptTermsOfService": { - "$ref": "AcceptTermsOfService", - "description": "Optional. The Terms of Service (ToS) to be accepted immediately upon account creation." - }, "account": { "$ref": "Account", "description": "Required. The account to be created." }, "service": { - "description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service.", + "description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation`, which means you can only create sub accounts, not standalone account through this method. Additional `account_management` or `product_management` services may be provided.", "items": { "$ref": "AddAccountService" }, @@ -1819,7 +1889,7 @@ "description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed." }, "maxHandlingDays": { - "description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.", + "description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.", "format": "int32", "type": "integer" }, @@ -1829,7 +1899,7 @@ "type": "integer" }, "minHandlingDays": { - "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.", + "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time.", "format": "int32", "type": "integer" }, diff --git a/discovery/merchantapi-conversions_v1beta.json b/discovery/merchantapi-conversions_v1beta.json index 53f48dbf79..bec0d8dcd5 100644 --- a/discovery/merchantapi-conversions_v1beta.json +++ b/discovery/merchantapi-conversions_v1beta.json @@ -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, @@ -295,7 +295,7 @@ } } }, - "revision": "20240827", + "revision": "20241001", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { diff --git a/discovery/merchantapi-datasources_v1beta.json b/discovery/merchantapi-datasources_v1beta.json index a7b93cc1c3..679083b6ec 100644 --- a/discovery/merchantapi-datasources_v1beta.json +++ b/discovery/merchantapi-datasources_v1beta.json @@ -285,12 +285,43 @@ "https://www.googleapis.com/auth/content" ] } + }, + "resources": { + "fileUploads": { + "methods": { + "get": { + "description": "Gets the latest data source file upload. Only the `latest` alias is accepted for a file upload.", + "flatPath": "datasources/v1beta/accounts/{accountsId}/dataSources/{dataSourcesId}/fileUploads/{fileUploadsId}", + "httpMethod": "GET", + "id": "merchantapi.accounts.dataSources.fileUploads.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the data source file upload to retrieve. Format: `accounts/{account}/dataSources/{datasource}/fileUploads/latest`", + "location": "path", + "pattern": "^accounts/[^/]+/dataSources/[^/]+/fileUploads/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "datasources/v1beta/{+name}", + "response": { + "$ref": "FileUpload" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } } } } } }, - "revision": "20240827", + "revision": "20240909", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -357,6 +388,39 @@ }, "type": "object" }, + "DataSourceReference": { + "description": "Data source reference can be used to manage related data sources within the data source service.", + "id": "DataSourceReference", + "properties": { + "primaryDataSourceName": { + "description": "Optional. The name of the primary data source. Format: `accounts/{account}/dataSources/{datasource}`", + "type": "string" + }, + "self": { + "description": "Self should be used to reference the primary data source itself.", + "type": "boolean" + }, + "supplementalDataSourceName": { + "description": "Optional. The name of the supplemental data source. Format: `accounts/{account}/dataSources/{datasource}`", + "type": "string" + } + }, + "type": "object" + }, + "DefaultRule": { + "description": "Default rule management of the data source.", + "id": "DefaultRule", + "properties": { + "takeFromDataSources": { + "description": "Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`.", + "items": { + "$ref": "DataSourceReference" + }, + "type": "array" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -477,6 +541,120 @@ }, "type": "object" }, + "FileUpload": { + "description": "The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources.", + "id": "FileUpload", + "properties": { + "dataSourceId": { + "description": "Output only. The data source id.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "issues": { + "description": "Output only. The list of issues occurring in the data source.", + "items": { + "$ref": "Issue" + }, + "readOnly": true, + "type": "array" + }, + "itemsCreated": { + "description": "Output only. The number of items in the data source that were created.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "itemsTotal": { + "description": "Output only. The number of items in the data source that were processed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "itemsUpdated": { + "description": "Output only. The number of items in the data source that were updated.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the data source file upload. Format: `{datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}`", + "type": "string" + }, + "processingState": { + "description": "Output only. The processing state of the data source.", + "enum": [ + "PROCESSING_STATE_UNSPECIFIED", + "FAILED", + "IN_PROGRESS", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Processing state unspecified.", + "The data source could not be processed or all the items had errors.", + "The data source is being processed.", + "The data source was processed successfully, though some items might have had errors." + ], + "readOnly": true, + "type": "string" + }, + "uploadTime": { + "description": "Output only. The date at which the file of the data source was uploaded.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Issue": { + "description": "An error occurring in the data source, like \"invalid price\".", + "id": "Issue", + "properties": { + "code": { + "description": "Output only. The code of the error, for example, \"validation/invalid_value\". Returns \"?\" if the code is unknown.", + "readOnly": true, + "type": "string" + }, + "count": { + "description": "Output only. The number of occurrences of the error in the file upload.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. The error description, for example, \"Your data source contains items which have too many attributes, or are too big. These items will be dropped\".", + "readOnly": true, + "type": "string" + }, + "documentationUri": { + "description": "Output only. Link to the documentation explaining the issue in more details, if available.", + "readOnly": true, + "type": "string" + }, + "severity": { + "description": "Output only. The severity of the issue.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "WARNING", + "ERROR" + ], + "enumDescriptions": [ + "Severity unspecified.", + "The issue is the warning.", + "The issue is an error." + ], + "readOnly": true, + "type": "string" + }, + "title": { + "description": "Output only. The title of the issue, for example, \"Item too big\".", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListDataSourcesResponse": { "description": "Response message for the ListDataSources method.", "id": "ListDataSourcesResponse", @@ -541,6 +719,10 @@ }, "type": "array" }, + "defaultRule": { + "$ref": "DefaultRule", + "description": "Optional. Default rule management of the data source. If set, the linked data sources will be replaced." + }, "feedLabel": { "description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", "type": "string" @@ -723,6 +905,14 @@ "feedLabel": { "description": "Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction.", "type": "string" + }, + "referencingPrimaryDataSources": { + "description": "Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed.", + "items": { + "$ref": "DataSourceReference" + }, + "readOnly": true, + "type": "array" } }, "type": "object" diff --git a/discovery/merchantapi-notifications_v1beta.json b/discovery/merchantapi-notifications_v1beta.json index 88587706ea..05b3e76e3b 100644 --- a/discovery/merchantapi-notifications_v1beta.json +++ b/discovery/merchantapi-notifications_v1beta.json @@ -110,7 +110,7 @@ "notificationsubscriptions": { "methods": { "create": { - "description": "Creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self we will not allow (per merchant as a subscriber per event type): 1. multiple self subscriptions. 2. multiple \"all managed accounts\" subscriptions. 3. all and partial subscriptions at the same time. 4. multiple partial subscriptions for the same target account", + "description": "Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For MCAs, the business can create a subscription for all managed accounts or for a specific subaccount. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", "flatPath": "notifications/v1beta/accounts/{accountsId}/notificationsubscriptions", "httpMethod": "POST", "id": "merchantapi.accounts.notificationsubscriptions.create", @@ -262,7 +262,7 @@ } } }, - "revision": "20240827", + "revision": "20240930", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/merchantapi-products_v1beta.json b/discovery/merchantapi-products_v1beta.json index 5a68f170bc..6930bb8260 100644 --- a/discovery/merchantapi-products_v1beta.json +++ b/discovery/merchantapi-products_v1beta.json @@ -211,7 +211,7 @@ ], "parameters": { "pageSize": { - "description": "The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned.", + "description": "The maximum number of products to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of products will be returned.", "format": "int32", "location": "query", "type": "integer" @@ -242,7 +242,7 @@ } } }, - "revision": "20240827", + "revision": "20241001", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -415,8 +415,11 @@ "type": "string" }, "gtin": { - "description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.", - "type": "string" + "description": "Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs.", + "items": { + "type": "string" + }, + "type": "array" }, "identifierExists": { "description": "Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.", @@ -1180,7 +1183,7 @@ "type": "string" }, "name": { - "description": "The name of the product. Format: `\"{product.name=accounts/{account}/products/{product}}\"`", + "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\"", "type": "string" }, "offerId": { @@ -1355,7 +1358,7 @@ "type": "string" }, "name": { - "description": "Identifier. The name of the product input. Format: `\"{productinput.name=accounts/{account}/productInputs/{productinput}}\"`", + "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\"", "type": "string" }, "offerId": { diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index 6212c8652b..0ff1b305c5 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -2309,7 +2309,7 @@ } } }, - "revision": "20240822", + "revision": "20240926", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2850,12 +2850,14 @@ "id": "ComputeEngineShapeDescriptor", "properties": { "logicalCoreCount": { - "description": "Number of logical cores.", + "description": "Output only. Number of logical cores.", "format": "int32", + "readOnly": true, "type": "integer" }, "machineType": { - "description": "Compute Engine machine type.", + "description": "Output only. Compute Engine machine type.", + "readOnly": true, "type": "string" }, "memoryMb": { @@ -2869,14 +2871,16 @@ "type": "integer" }, "series": { - "description": "Compute Engine machine series.", + "description": "Output only. Compute Engine machine series.", + "readOnly": true, "type": "string" }, "storage": { - "description": "Compute Engine storage. Never empty.", + "description": "Output only. Compute Engine storage. Never empty.", "items": { "$ref": "ComputeStorageDescriptor" }, + "readOnly": true, "type": "array" } }, @@ -2887,12 +2891,13 @@ "id": "ComputeStorageDescriptor", "properties": { "sizeGb": { - "description": "Disk size in GiB.", + "description": "Output only. Disk size in GiB.", "format": "int32", + "readOnly": true, "type": "integer" }, "type": { - "description": "Disk type backing the storage.", + "description": "Output only. Disk type backing the storage.", "enum": [ "PERSISTENT_DISK_TYPE_UNSPECIFIED", "PERSISTENT_DISK_TYPE_STANDARD", @@ -2905,6 +2910,7 @@ "Balanced Persistent Disk.", "SSD Persistent Disk." ], + "readOnly": true, "type": "string" } }, @@ -3377,7 +3383,7 @@ "id": "FitDescriptor", "properties": { "fitLevel": { - "description": "Fit level.", + "description": "Output only. Fit level.", "enum": [ "FIT_LEVEL_UNSPECIFIED", "FIT", @@ -3390,6 +3396,7 @@ "No Fit.", "Fit with effort." ], + "readOnly": true, "type": "string" } }, @@ -4358,7 +4365,8 @@ "type": "integer" }, "cpuThreadCount": { - "description": "Number of CPU threads allocated to the machine.", + "deprecated": true, + "description": "Deprecated: use MachineDetails.core_count instead. Number of CPU threads allocated to the machine.", "format": "int32", "type": "integer" }, @@ -5192,7 +5200,7 @@ "properties": { "coreCountHistogram": { "$ref": "ReportSummaryHistogramChartData", - "description": "Histogram showing a distribution of CPU core counts." + "description": "Histogram showing a distribution of logical CPU core counts." }, "memoryBytesHistogram": { "$ref": "ReportSummaryHistogramChartData", diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 2a4ccadef3..044447a6e3 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2548,7 +2548,7 @@ } } }, - "revision": "20240822", + "revision": "20240926", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2828,8 +2828,7 @@ }, "performanceData": { "$ref": "AssetPerformanceData", - "description": "Output only. Performance data for the asset.", - "readOnly": true + "description": "Performance data for the asset." }, "sources": { "description": "Output only. The list of sources contributing to the asset.", @@ -2969,6 +2968,10 @@ "readOnly": true, "type": "string" }, + "inventory": { + "$ref": "AssetsExportJobInventory", + "description": "Export asset inventory details." + }, "labels": { "additionalProperties": { "type": "string" @@ -2985,6 +2988,10 @@ "$ref": "AssetsExportJobNetworkDependencies", "description": "Export data regarding asset network dependencies." }, + "performanceData": { + "$ref": "AssetsExportJobPerformanceData", + "description": "Export asset with performance data." + }, "recentExecutions": { "description": "Output only. Recent non expired executions of the job.", "items": { @@ -2993,6 +3000,10 @@ "readOnly": true, "type": "array" }, + "showHidden": { + "description": "Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.", + "type": "boolean" + }, "signedUriDestination": { "$ref": "SignedUriDestination", "description": "Export to Cloud Storage files downloadable using signed URIs." @@ -3027,6 +3038,12 @@ "readOnly": true, "type": "string" }, + "requestedAssetCount": { + "description": "Output only. Number of assets requested for export after resolving the requested filters.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "result": { "$ref": "AssetsExportJobExecutionResult", "description": "Output only. Result of the export execution.", @@ -3050,6 +3067,11 @@ "description": "Output only. Error encountered during export.", "readOnly": true }, + "outputFiles": { + "$ref": "OutputFileList", + "description": "Output only. List of output files.", + "readOnly": true + }, "signedUris": { "$ref": "SignedUris", "description": "Output only. Signed URLs for downloading export artifacts.", @@ -3069,6 +3091,12 @@ }, "type": "object" }, + "AssetsExportJobInventory": { + "description": "Configuration for asset inventory details exports.", + "id": "AssetsExportJobInventory", + "properties": {}, + "type": "object" + }, "AssetsExportJobNetworkDependencies": { "description": "Configuration for network dependencies exports.", "id": "AssetsExportJobNetworkDependencies", @@ -3081,6 +3109,18 @@ }, "type": "object" }, + "AssetsExportJobPerformanceData": { + "description": "Configuration for performance data exports.", + "id": "AssetsExportJobPerformanceData", + "properties": { + "maxDays": { + "description": "Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "AwsEc2PlatformDetails": { "description": "AWS EC2 specific details.", "id": "AwsEc2PlatformDetails", @@ -3228,7 +3268,7 @@ }, "cloudSqlForPostgresqlShape": { "$ref": "CloudSqlForPostgreSqlShape", - "description": "Cloud SQL for Postgres database shape." + "description": "Cloud SQL for PostgreSQL database shape." }, "cloudSqlShape": { "$ref": "CloudSqlForSqlServerShape", @@ -3321,7 +3361,7 @@ "type": "object" }, "CloudSqlForPostgreSqlShape": { - "description": "Cloud SQL for Postgres database shape.", + "description": "Cloud SQL for PostgreSQL database shape.", "id": "CloudSqlForPostgreSqlShape", "properties": { "backupStorageGb": { @@ -3653,7 +3693,7 @@ "type": "integer" }, "type": { - "description": "Disk type backing the storage.", + "description": "Output only. Disk type backing the storage.", "enum": [ "PERSISTENT_DISK_TYPE_UNSPECIFIED", "PERSISTENT_DISK_TYPE_STANDARD", @@ -3666,6 +3706,7 @@ "Balanced Persistent Disk.", "SSD Persistent Disk." ], + "readOnly": true, "type": "string" } }, @@ -3683,6 +3724,30 @@ }, "type": "object" }, + "CsvOutputFile": { + "description": "Contains a single output file of type CSV.", + "id": "CsvOutputFile", + "properties": { + "columnsCount": { + "description": "Output only. Number of columns in the file.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "rowCount": { + "description": "Output only. Number of rows in the file.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "signedUri": { + "$ref": "SignedUri", + "description": "Output only. Signed URI destination.", + "readOnly": true + } + }, + "type": "object" + }, "DailyResourceUsageAggregation": { "description": "Usage data aggregation for a single day.", "id": "DailyResourceUsageAggregation", @@ -4084,7 +4149,7 @@ "type": "string" }, "edition": { - "description": "Optional. Cloud SQL edition. For SQL Server, only Enterprise is available.", + "description": "Optional. Preferred Cloud SQL edition.", "enum": [ "CLOUD_SQL_EDITION_UNSPECIFIED", "CLOUD_SQL_EDITION_ENTERPRISE", @@ -4153,7 +4218,7 @@ "id": "DatabasePreferencesCloudSqlCommonBackup", "properties": { "backupMode": { - "description": "Optional. Mode of automated backups.", + "description": "Optional. Automated backup mode.", "enum": [ "BACKUP_MODE_UNSPECIFIED", "BACKUP_MODE_DISABLED", @@ -4695,7 +4760,7 @@ "id": "FitDescriptor", "properties": { "fitLevel": { - "description": "Fit level.", + "description": "Output only. Fit level.", "enum": [ "FIT_LEVEL_UNSPECIFIED", "FIT", @@ -4708,6 +4773,7 @@ "No Fit.", "Fit with effort." ], + "readOnly": true, "type": "string" } }, @@ -4926,7 +4992,8 @@ }, "hosts": { "$ref": "HostsEntryList", - "description": "Hosts file (/etc/hosts)." + "description": "Output only. Hosts file (/etc/hosts).", + "readOnly": true }, "issue": { "description": "OS issue (typically /etc/issue in Linux).", @@ -5068,10 +5135,11 @@ "id": "HostsEntryList", "properties": { "entries": { - "description": "Hosts entries.", + "description": "Output only. Hosts entries.", "items": { "$ref": "HostsEntry" }, + "readOnly": true, "type": "array" } }, @@ -6496,6 +6564,38 @@ }, "type": "object" }, + "OutputFile": { + "description": "Contains a single output file.", + "id": "OutputFile", + "properties": { + "csvOutputFile": { + "$ref": "CsvOutputFile", + "description": "Output only. CSV output file.", + "readOnly": true + }, + "fileSizeBytes": { + "description": "Output only. File size in bytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "OutputFileList": { + "description": "Contains a list of output files.", + "id": "OutputFileList", + "properties": { + "entries": { + "description": "List of output files.", + "items": { + "$ref": "OutputFile" + }, + "type": "array" + } + }, + "type": "object" + }, "PayloadFile": { "description": "Payload file for inline import job payload.", "id": "PayloadFile", @@ -6973,7 +7073,7 @@ }, "coreCountHistogram": { "$ref": "ReportSummaryHistogramChartData", - "description": "Histogram showing a distribution of CPU core counts." + "description": "Histogram showing a distribution of logical CPU core counts." }, "databaseTypes": { "$ref": "ReportSummaryChartData", @@ -7117,7 +7217,7 @@ "Unknown database type.", "SQL Server database.", "MySQL database.", - "Postgres database." + "PostgreSQL database." ], "readOnly": true, "type": "string" @@ -7204,7 +7304,7 @@ }, "monthlyCostOsLicense": { "$ref": "Money", - "description": "Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines.", + "description": "Output only. All operating systems licensing monthly cost for this preference set. Only present for virtual machines.", "readOnly": true }, "monthlyCostOther": { @@ -8177,7 +8277,8 @@ "type": "integer" }, "cpuThreadCount": { - "description": "Number of CPU threads allocated to the machine.", + "deprecated": true, + "description": "Deprecated: use VirtualMachineDetails.core_count instead. Number of CPU threads allocated to the machine.", "format": "int32", "type": "integer" }, diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 3465873113..af52005bae 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20240721", + "revision": "20240929", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1022,10 +1022,37 @@ "description": "The persistent settings for a table's columns.", "id": "ColumnSettings", "properties": { + "alignment": { + "description": "Optional. Whether the column should be left / middle / right aligned", + "enum": [ + "CELL_ALIGNMENT_UNSPECIFIED", + "LEFT", + "CENTER", + "RIGHT" + ], + "enumDescriptions": [ + "No horizontal alignment specified; fall back to the default behavior. Label values are left aligned. Numeric values are right aligned.", + "Left-align", + "Center-align", + "Right-align" + ], + "type": "string" + }, "column": { "description": "Required. The id of the column.", "type": "string" }, + "displayName": { + "description": "Optional. Display name of the column", + "type": "string" + }, + "thresholds": { + "description": "Optional. The thresholds used to determine how the table cell should be rendered given the time series' current value.", + "items": { + "$ref": "Threshold" + }, + "type": "array" + }, "visible": { "description": "Required. Whether the column should be visible on page load.", "type": "boolean" @@ -1386,7 +1413,8 @@ "CLOUD_SQL_STORAGE", "UPTIME_CHECK_FAILURE", "CLOUD_ALERTING_ALERT", - "SERVICE_HEALTH_INCIDENT" + "SERVICE_HEALTH_INCIDENT", + "SAP_BACKINT" ], "enumDescriptions": [ "No event type specified.", @@ -1410,7 +1438,8 @@ "Storage event for a Cloud SQL instance.", "Failure of a Cloud Monitoring uptime check.", "Alerts from Cloud Alerting", - "Incidents from Service Health" + "Incidents from Service Health", + "Agent for SAP Backint related events." ], "type": "string" }, @@ -2027,7 +2056,7 @@ "type": "string" }, "query": { - "description": "A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", + "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", "type": "string" }, "start": { @@ -2042,7 +2071,7 @@ "id": "QueryInstantRequest", "properties": { "query": { - "description": "A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", + "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", "type": "string" }, "time": { @@ -2084,7 +2113,7 @@ "type": "string" }, "query": { - "description": "A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", + "description": "A PromQL query string. Query language documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/.", "type": "string" }, "start": { diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index 6c3c6074b3..100a994286 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -2114,7 +2114,7 @@ }, "query": { "deprecated": true, - "description": "Queries time series using Monitoring Query Language.", + "description": "Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "flatPath": "v3/projects/{projectsId}/timeSeries:query", "httpMethod": "POST", "id": "monitoring.projects.timeSeries.query", @@ -2715,7 +2715,7 @@ } } }, - "revision": "20240818", + "revision": "20240929", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -3020,6 +3020,17 @@ }, "type": "object" }, + "BooleanTest": { + "description": "A test that uses an alerting result in a boolean column produced by the SQL query.", + "id": "BooleanTest", + "properties": { + "column": { + "description": "Required. The name of the column containing the boolean value. If the value in a row is NULL, that row is ignored.", + "type": "string" + } + }, + "type": "object" + }, "BucketOptions": { "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", "id": "BucketOptions", @@ -3243,6 +3254,10 @@ "$ref": "PrometheusQueryLanguageCondition", "description": "A condition that uses the Prometheus query language to define alerts." }, + "conditionSql": { + "$ref": "SqlCondition", + "description": "A condition that uses SQL to define alerts in Logs Analytics." + }, "conditionThreshold": { "$ref": "MetricThreshold", "description": "A condition that compares a time series against a threshold." @@ -3393,6 +3408,22 @@ "properties": {}, "type": "object" }, + "Daily": { + "description": "Used to schedule the query to run every so many days.", + "id": "Daily", + "properties": { + "executionTime": { + "$ref": "TimeOfDay", + "description": "Optional. The time of day (in UTC) at which the query should run. If left unspecified, the server picks an arbitrary time of day and runs the query at the same time each day." + }, + "periodicity": { + "description": "Required. LINT.IfChange The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Distribution": { "description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.", "id": "Distribution", @@ -3854,6 +3885,23 @@ }, "type": "object" }, + "Hourly": { + "description": "Used to schedule the query to run every so many hours.", + "id": "Hourly", + "properties": { + "minuteOffset": { + "description": "Optional. LINT.IfChange The number of minutes after the hour (in UTC) to run the query. Must be between 0 and 59 inclusive. If left unspecified, then an arbitrary offset is used. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", + "format": "int32", + "type": "integer" + }, + "periodicity": { + "description": "Required. LINT.IfChange The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "HttpCheck": { "description": "Information involved in an HTTP/HTTPS Uptime check request.", "id": "HttpCheck", @@ -4621,6 +4669,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -4725,6 +4792,18 @@ }, "type": "object" }, + "Minutes": { + "description": "Used to schedule the query to run every so many minutes.", + "id": "Minutes", + "properties": { + "periodicity": { + "description": "Required. LINT.IfChange Number of minutes between runs. The interval must be between 5 minutes and 1440 minutes. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc)", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"project_id\", \"instance_id\" and \"zone\": { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }} ", "id": "MonitoredResource", @@ -5197,7 +5276,7 @@ }, "QueryTimeSeriesRequest": { "deprecated": true, - "description": "The QueryTimeSeries request.", + "description": "The QueryTimeSeries request. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "id": "QueryTimeSeriesRequest", "properties": { "pageSize": { @@ -5218,7 +5297,7 @@ }, "QueryTimeSeriesResponse": { "deprecated": true, - "description": "The QueryTimeSeries response.", + "description": "The QueryTimeSeries response. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql).", "id": "QueryTimeSeriesResponse", "properties": { "nextPageToken": { @@ -5337,6 +5416,40 @@ }, "type": "object" }, + "RowCountTest": { + "description": "A test that checks if the number of rows in the result set violates some threshold.", + "id": "RowCountTest", + "properties": { + "comparison": { + "description": "Required. The comparison to apply between the number of rows returned by the query and the threshold.", + "enum": [ + "COMPARISON_UNSPECIFIED", + "COMPARISON_GT", + "COMPARISON_GE", + "COMPARISON_LT", + "COMPARISON_LE", + "COMPARISON_EQ", + "COMPARISON_NE" + ], + "enumDescriptions": [ + "No ordering relationship is specified.", + "True if the left argument is greater than the right argument.", + "True if the left argument is greater than or equal to the right argument.", + "True if the left argument is less than the right argument.", + "True if the left argument is less than or equal to the right argument.", + "True if the left argument is equal to the right argument.", + "True if the left argument is not equal to the right argument." + ], + "type": "string" + }, + "threshold": { + "description": "Required. The value against which to compare the row count.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "SendNotificationChannelVerificationCodeRequest": { "description": "The SendNotificationChannelVerificationCode request.", "id": "SendNotificationChannelVerificationCodeRequest", @@ -5556,6 +5669,37 @@ }, "type": "object" }, + "SqlCondition": { + "description": "A condition that allows alert policies to be defined using GoogleSQL. SQL conditions examine a sliding window of logs using GoogleSQL. Alert policies with SQL conditions may incur additional billing.", + "id": "SqlCondition", + "properties": { + "booleanTest": { + "$ref": "BooleanTest", + "description": "Test the boolean value in the indicated column." + }, + "daily": { + "$ref": "Daily", + "description": "Schedule the query to execute every so many days." + }, + "hourly": { + "$ref": "Hourly", + "description": "Schedule the query to execute every so many hours." + }, + "minutes": { + "$ref": "Minutes", + "description": "Schedule the query to execute every so many minutes." + }, + "query": { + "description": "Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.E.g. Extract all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL", + "type": "string" + }, + "rowCountTest": { + "$ref": "RowCountTest", + "description": "Test the row count against a threshold." + } + }, + "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", @@ -5638,6 +5782,33 @@ }, "type": "object" }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "TimeSeries": { "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", "id": "TimeSeries", diff --git a/discovery/mybusinessbusinessinformation-v1.json b/discovery/mybusinessbusinessinformation-v1.json index f0241b43c4..236042f634 100644 --- a/discovery/mybusinessbusinessinformation-v1.json +++ b/discovery/mybusinessbusinessinformation-v1.json @@ -612,7 +612,7 @@ } } }, - "revision": "20231212", + "revision": "20241002", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1696,22 +1696,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/mybusinesslodging-v1.json b/discovery/mybusinesslodging-v1.json index 66af81e9f1..3c6946d3b1 100644 --- a/discovery/mybusinesslodging-v1.json +++ b/discovery/mybusinesslodging-v1.json @@ -194,7 +194,7 @@ } } }, - "revision": "20231114", + "revision": "20241002", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { @@ -5215,22 +5215,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index b64bb8db0a..3932967028 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -2812,7 +2812,7 @@ } } }, - "revision": "20240807", + "revision": "20240923", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2942,9 +2942,17 @@ "type": "string" }, "producerInstanceId": { - "description": "Immutable. An immutable identifier for the producer instance.", + "deprecated": true, + "description": "Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.", "type": "string" }, + "producerInstanceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Immutable. An immutable map for the producer instance metadata.", + "type": "object" + }, "project": { "description": "The consumer project where PSC connections are allowed to be created in.", "type": "string" @@ -2994,6 +3002,7 @@ "readOnly": true }, "errorType": { + "deprecated": true, "description": "The error type indicates whether the error is consumer facing, producer facing or system internal.", "enum": [ "CONNECTION_ERROR_TYPE_UNSPECIFIED", @@ -3026,9 +3035,17 @@ "type": "string" }, "producerInstanceId": { - "description": "Immutable. An immutable identifier for the producer instance.", + "deprecated": true, + "description": "Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.", "type": "string" }, + "producerInstanceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Immutable. An immutable map for the producer instance metadata.", + "type": "object" + }, "project": { "description": "The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.", "type": "string" @@ -3057,7 +3074,7 @@ ], "enumDescriptions": [ "An invalid state as the default case.", - "The connection is fully established and ready to use.", + "The connection has been created successfully. However, for the up-to-date connection status, please use the service attachment's \"ConnectedEndpoint.status\" as the source of truth.", "The connection is not functional since some resources on the connection fail to be created.", "The connection is being created.", "The connection is being deleted." @@ -3451,7 +3468,7 @@ "type": "string" }, "ipCidrRange": { - "description": "The IP range that this internal range defines.", + "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" }, "labels": { @@ -3461,6 +3478,10 @@ "description": "User-defined labels.", "type": "object" }, + "migration": { + "$ref": "Migration", + "description": "Optional. Should be present if usage is set to FOR_MIGRATION." + }, "name": { "description": "Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" @@ -3503,7 +3524,7 @@ "type": "string" }, "prefixLength": { - "description": "An alternate to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.", + "description": "An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.", "format": "int32", "type": "integer" }, @@ -3524,12 +3545,14 @@ "enum": [ "USAGE_UNSPECIFIED", "FOR_VPC", - "EXTERNAL_TO_VPC" + "EXTERNAL_TO_VPC", + "FOR_MIGRATION" ], "enumDescriptions": [ "Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.", "A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.", - "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect." + "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases, like for example, usage on-prem, with dynamic route announcements via interconnect.", + "Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset." ], "type": "string" }, @@ -3549,7 +3572,7 @@ "id": "LinkedInterconnectAttachments", "properties": { "includeImportRanges": { - "description": "Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is \"ALL_IPV4_RANGES\".", + "description": "Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is \"ALL_IPV4_RANGES\".", "items": { "type": "string" }, @@ -3574,12 +3597,44 @@ }, "type": "object" }, + "LinkedProducerVpcNetwork": { + "description": "Next ID: 7", + "id": "LinkedProducerVpcNetwork", + "properties": { + "excludeExportRanges": { + "description": "Optional. IP ranges encompassing the subnets to be excluded from peering.", + "items": { + "type": "string" + }, + "type": "array" + }, + "network": { + "description": "Immutable. The URI of the Service Consumer VPC that the Producer VPC is peered with.", + "type": "string" + }, + "peering": { + "description": "Immutable. The name of the VPC peering between the Service Consumer VPC and the Producer VPC (defined in the Tenant project) which is added to the NCC hub. This peering must be in ACTIVE state.", + "type": "string" + }, + "producerNetwork": { + "description": "Output only. The URI of the Producer VPC.", + "readOnly": true, + "type": "string" + }, + "serviceConsumerVpcSpoke": { + "description": "Output only. The Service Consumer Network spoke.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "LinkedRouterApplianceInstances": { "description": "A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke.", "id": "LinkedRouterApplianceInstances", "properties": { "includeImportRanges": { - "description": "Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is \"ALL_IPV4_RANGES\".", + "description": "Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is \"ALL_IPV4_RANGES\".", "items": { "type": "string" }, @@ -3642,7 +3697,7 @@ "id": "LinkedVpnTunnels", "properties": { "includeImportRanges": { - "description": "Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is \"ALL_IPV4_RANGES\".", + "description": "Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is \"ALL_IPV4_RANGES\".", "items": { "type": "string" }, @@ -4068,6 +4123,21 @@ }, "type": "object" }, + "Migration": { + "description": "Specification for migration with source and target resource names.", + "id": "Migration", + "properties": { + "source": { + "description": "Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}", + "type": "string" + }, + "target": { + "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", + "type": "string" + } + }, + "type": "object" + }, "NextHopInterconnectAttachment": { "description": "A route next hop that leads to an interconnect attachment resource.", "id": "NextHopInterconnectAttachment", @@ -4367,7 +4437,7 @@ "error": { "$ref": "GoogleRpcStatus", "deprecated": true, - "description": "The most recent error during operating this connection." + "description": "The most recent error during operating this connection. Deprecated, please use error_info instead." }, "errorInfo": { "$ref": "GoogleRpcErrorInfo", @@ -4375,6 +4445,7 @@ "readOnly": true }, "errorType": { + "deprecated": true, "description": "The error type indicates whether the error is consumer facing, producer facing or system internal.", "enum": [ "CONNECTION_ERROR_TYPE_UNSPECIFIED", @@ -4395,9 +4466,17 @@ "type": "string" }, "producerInstanceId": { - "description": "Immutable. An immutable identifier for the producer instance.", + "deprecated": true, + "description": "Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance.", "type": "string" }, + "producerInstanceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Immutable. An immutable map for the producer instance metadata.", + "type": "object" + }, "pscConnectionId": { "description": "The PSC connection id of the PSC forwarding rule.", "type": "string" @@ -4407,6 +4486,11 @@ "readOnly": true, "type": "string" }, + "serviceClass": { + "description": "Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer.", + "readOnly": true, + "type": "string" + }, "state": { "description": "State of the PSC Connection", "enum": [ @@ -4418,7 +4502,7 @@ ], "enumDescriptions": [ "An invalid state as the default case.", - "The connection is fully established and ready to use.", + "The connection has been created successfully. However, for the up-to-date connection status, please use the created forwarding rule's \"PscConnectionStatus\" as the source of truth.", "The connection is not functional since some resources on the connection fail to be created.", "The connection is being created.", "The connection is being deleted." @@ -4882,7 +4966,7 @@ "id": "ServiceConnectionPolicy", "properties": { "createTime": { - "description": "Output only. Time when the ServiceConnectionMap was created.", + "description": "Output only. Time when the ServiceConnectionPolicy was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -4940,7 +5024,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. Time when the ServiceConnectionMap was updated.", + "description": "Output only. Time when the ServiceConnectionPolicy was updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -5050,6 +5134,10 @@ "$ref": "LinkedInterconnectAttachments", "description": "VLAN attachments that are associated with the spoke." }, + "linkedProducerVpcNetwork": { + "$ref": "LinkedProducerVpcNetwork", + "description": "Optional. The linked producer VPC that is associated with the spoke." + }, "linkedRouterApplianceInstances": { "$ref": "LinkedRouterApplianceInstances", "description": "Router appliance instances that are associated with the spoke." @@ -5081,14 +5169,16 @@ "VPN_TUNNEL", "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", - "VPC_NETWORK" + "VPC_NETWORK", + "PRODUCER_VPC_NETWORK" ], "enumDescriptions": [ "Unspecified spoke type.", "Spokes associated with VPN tunnels.", "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", - "Spokes associated with VPC networks." + "Spokes associated with VPC networks.", + "Spokes that are backed by a producer VPC network." ], "readOnly": true, "type": "string" @@ -5254,14 +5344,16 @@ "VPN_TUNNEL", "INTERCONNECT_ATTACHMENT", "ROUTER_APPLIANCE", - "VPC_NETWORK" + "VPC_NETWORK", + "PRODUCER_VPC_NETWORK" ], "enumDescriptions": [ "Unspecified spoke type.", "Spokes associated with VPN tunnels.", "Spokes associated with VLAN attachments.", "Spokes associated with router appliance instances.", - "Spokes associated with VPC networks." + "Spokes associated with VPC networks.", + "Spokes that are backed by a producer VPC network." ], "readOnly": true, "type": "string" diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index 7145a68cdc..b0083408a3 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, - "revision": "20240807", + "revision": "20240911", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1383,7 +1383,7 @@ "type": "string" }, "ipCidrRange": { - "description": "IP range that this internal range defines.", + "description": "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" }, "labels": { @@ -1439,7 +1439,7 @@ "type": "string" }, "prefixLength": { - "description": "An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size.", + "description": "An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter.", "format": "int32", "type": "integer" }, diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index 76ca095ebe..239a2e485c 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240821", + "revision": "20240918", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -630,6 +630,8 @@ "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", + "SOURCE_REDIS_CLUSTER_UNSUPPORTED", + "SOURCE_REDIS_INSTANCE_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", @@ -668,6 +670,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -700,6 +704,8 @@ "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 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.", "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", @@ -1045,7 +1051,9 @@ "CLOUD_FUNCTION", "APP_ENGINE_VERSION", "CLOUD_RUN_REVISION", - "GOOGLE_MANAGED_SERVICE" + "GOOGLE_MANAGED_SERVICE", + "REDIS_INSTANCE", + "REDIS_CLUSTER" ], "enumDescriptions": [ "Target not specified.", @@ -1063,7 +1071,9 @@ "Target is a Cloud Function. Used only for return traces.", "Target is a App Engine service version. Used only for return traces.", "Target is a Cloud Run revision. Used only for return traces.", - "Target is a Google-managed service. Used only for return traces." + "Target is a Google-managed service. Used only for return traces.", + "Target is a Redis Instance.", + "Target is a Redis Cluster." ], "type": "string" } @@ -1106,6 +1116,7 @@ "GKE_CLUSTER_NOT_RUNNING", "CLOUD_SQL_INSTANCE_NOT_RUNNING", "REDIS_INSTANCE_NOT_RUNNING", + "REDIS_CLUSTER_NOT_RUNNING", "TRAFFIC_TYPE_BLOCKED", "GKE_MASTER_UNAUTHORIZED_ACCESS", "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", @@ -1145,7 +1156,20 @@ "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", "LOAD_BALANCER_BACKEND_INVALID_NETWORK", "BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED", - "DESTINATION_IS_PRIVATE_NAT_IP_RANGE" + "DESTINATION_IS_PRIVATE_NAT_IP_RANGE", + "DROPPED_INSIDE_REDIS_INSTANCE_SERVICE", + "REDIS_INSTANCE_UNSUPPORTED_PORT", + "REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS", + "REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK", + "REDIS_INSTANCE_NO_EXTERNAL_IP", + "REDIS_INSTANCE_UNSUPPORTED_PROTOCOL", + "DROPPED_INSIDE_REDIS_CLUSTER_SERVICE", + "REDIS_CLUSTER_UNSUPPORTED_PORT", + "REDIS_CLUSTER_NO_EXTERNAL_IP", + "REDIS_CLUSTER_UNSUPPORTED_PROTOCOL", + "NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION", + "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", + "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1177,6 +1201,7 @@ "Packet sent from or to a GKE cluster that is not in running state.", "Packet sent from or to a Cloud SQL instance that is not in running state.", "Packet sent from or to a Redis Instance that is not in running state.", + "Packet sent from or to a Redis Cluster that is not in running state.", "The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](https://cloud.google.com/vpc/docs/firewalls#blockedtraffic) for more details.", "Access to Google Kubernetes Engine cluster master's endpoint is not authorized. See [Access to the cluster endpoints](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details.", "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", @@ -1216,7 +1241,20 @@ "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", "Packet is dropped due to a backend service named port not being defined on the instance group level.", - "Packet is dropped due to a destination IP range being part of a Private NAT IP range." + "Packet is dropped due to a destination IP range being part of a Private NAT IP range.", + "Generic drop cause for a packet being dropped inside a Redis Instance service project.", + "Packet is dropped due to an unsupported port being used to connect to a Redis Instance. Port 6379 should be used to connect to a Redis Instance.", + "Packet is dropped due to connecting from PUPI address to a PSA based Redis Instance.", + "Packet is dropped due to no route to the destination network.", + "Redis Instance does not have an external IP address.", + "Packet is dropped due to an unsupported protocol being used to connect to a Redis Instance. Only TCP connections are accepted by a Redis Instance.", + "Generic drop cause for a packet being dropped inside a Redis Cluster service project.", + "Packet is dropped due to an unsupported port being used to connect to a Redis Cluster. Ports 6379 and 11000 to 13047 should be used to connect to a Redis Cluster.", + "Redis Cluster does not have an external IP address.", + "Packet is dropped due to an unsupported protocol being used to connect to a Redis Cluster. Only TCP connections are accepted by a Redis Cluster.", + "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." ], "type": "string" }, @@ -1373,6 +1411,14 @@ "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.", "type": "string" + }, + "redisCluster": { + "description": "A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI.", + "type": "string" + }, + "redisInstance": { + "description": "A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI.", + "type": "string" } }, "type": "object" @@ -2098,7 +2144,7 @@ "type": "object" }, "NetworkInfo": { - "description": "For display only. Metadata associated with a Compute Engine network.", + "description": "For display only. Metadata associated with a Compute Engine network. Next ID: 7", "id": "NetworkInfo", "properties": { "displayName": { @@ -2106,7 +2152,15 @@ "type": "string" }, "matchedIpRange": { - "description": "The IP range that matches the test.", + "description": "The IP range of the subnet matching the source IP address of the test.", + "type": "string" + }, + "matchedSubnetUri": { + "description": "URI of the subnet matching the source IP address of the test.", + "type": "string" + }, + "region": { + "description": "The region of the subnet matching the source IP address of the test.", "type": "string" }, "uri": { @@ -2385,6 +2439,37 @@ }, "type": "object" }, + "RedisClusterInfo": { + "description": "For display only. Metadata associated with a Redis Cluster.", + "id": "RedisClusterInfo", + "properties": { + "discoveryEndpointIpAddress": { + "description": "Discovery endpoint IP address of a Redis Cluster.", + "type": "string" + }, + "displayName": { + "description": "Name of a Redis Cluster.", + "type": "string" + }, + "location": { + "description": "Name of the region in which the Redis Cluster is defined. For example, \"us-central1\".", + "type": "string" + }, + "networkUri": { + "description": "URI of a Redis Cluster network in format \"projects/{project_id}/global/networks/{network_id}\".", + "type": "string" + }, + "secondaryEndpointIpAddress": { + "description": "Secondary endpoint IP address of a Redis Cluster.", + "type": "string" + }, + "uri": { + "description": "URI of a Redis Cluster in format \"projects/{project_id}/locations/{location}/clusters/{cluster_id}\"", + "type": "string" + } + }, + "type": "object" + }, "RedisInstanceInfo": { "description": "For display only. Metadata associated with a Cloud Redis Instance.", "id": "RedisInstanceInfo", @@ -2426,6 +2511,14 @@ "description": "For display only. Metadata associated with a Compute Engine route.", "id": "RouteInfo", "properties": { + "advertisedRouteNextHopUri": { + "description": "For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.", + "type": "string" + }, + "advertisedRouteSourceRouterUri": { + "description": "For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.", + "type": "string" + }, "destIpRange": { "description": "Destination IP range of the route.", "type": "string" @@ -2510,6 +2603,10 @@ }, "type": "array" }, + "region": { + "description": "Region of the route (if applicable).", + "type": "string" + }, "routeScope": { "description": "Indicates where route is applicable.", "enum": [ @@ -2534,7 +2631,8 @@ "PEERING_SUBNET", "PEERING_STATIC", "PEERING_DYNAMIC", - "POLICY_BASED" + "POLICY_BASED", + "ADVERTISED" ], "enumDescriptions": [ "Unspecified type. Default value.", @@ -2544,7 +2642,8 @@ "A subnet route received from peering network.", "A static route received from peering network.", "A dynamic route received from peering network.", - "Policy based route." + "Policy based route.", + "Advertised route. Synthetic route which is used to transition from the StartFromPrivateNetwork state in Connectivity tests." ], "type": "string" }, @@ -2560,7 +2659,7 @@ "type": "array" }, "uri": { - "description": "URI of a route. Dynamic, peering static and peering dynamic routes do not have an URI. Advertised route from Google Cloud VPC to on-premises network also does not have an URI.", + "description": "URI of a route (if applicable).", "type": "string" } }, @@ -2713,6 +2812,10 @@ "$ref": "ProxyConnectionInfo", "description": "Display information of a ProxyConnection." }, + "redisCluster": { + "$ref": "RedisClusterInfo", + "description": "Display information of a Redis Cluster." + }, "redisInstance": { "$ref": "RedisInstanceInfo", "description": "Display information of a Redis Instance." @@ -2736,6 +2839,7 @@ "START_FROM_GKE_MASTER", "START_FROM_CLOUD_SQL_INSTANCE", "START_FROM_REDIS_INSTANCE", + "START_FROM_REDIS_CLUSTER", "START_FROM_CLOUD_FUNCTION", "START_FROM_APP_ENGINE_VERSION", "START_FROM_CLOUD_RUN_REVISION", @@ -2784,6 +2888,7 @@ false, false, false, + false, true, true, false, @@ -2806,6 +2911,7 @@ "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", "Initial state: packet originating from a Redis instance. A RedisInstanceInfo is populated with starting instance information.", + "Initial state: packet originating from a Redis Cluster. A RedisClusterInfo is populated with starting Cluster information.", "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information.", "Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information.", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index a310e663ea..f033dd10e2 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -758,7 +758,7 @@ } } }, - "revision": "20240821", + "revision": "20240918", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -797,6 +797,8 @@ "ROUTE_CONFIG_NOT_FOUND", "GOOGLE_MANAGED_SERVICE_AMBIGUOUS_PSC_ENDPOINT", "SOURCE_PSC_CLOUD_SQL_UNSUPPORTED", + "SOURCE_REDIS_CLUSTER_UNSUPPORTED", + "SOURCE_REDIS_INSTANCE_UNSUPPORTED", "SOURCE_FORWARDING_RULE_UNSUPPORTED", "NON_ROUTABLE_IP_ADDRESS", "UNKNOWN_ISSUE_IN_GOOGLE_MANAGED_PROJECT", @@ -835,6 +837,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -867,6 +871,8 @@ "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 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.", "Aborted because tests with a forwarding rule as a source are not supported.", "Aborted because one of the endpoints is a non-routable IP address (loopback, link-local, etc).", "Aborted due to an unknown issue in the Google-managed project.", @@ -1217,7 +1223,9 @@ "CLOUD_FUNCTION", "APP_ENGINE_VERSION", "CLOUD_RUN_REVISION", - "GOOGLE_MANAGED_SERVICE" + "GOOGLE_MANAGED_SERVICE", + "REDIS_INSTANCE", + "REDIS_CLUSTER" ], "enumDescriptions": [ "Target not specified.", @@ -1235,7 +1243,9 @@ "Target is a Cloud Function. Used only for return traces.", "Target is a App Engine service version. Used only for return traces.", "Target is a Cloud Run revision. Used only for return traces.", - "Target is a Google-managed service. Used only for return traces." + "Target is a Google-managed service. Used only for return traces.", + "Target is a Redis Instance.", + "Target is a Redis Cluster." ], "type": "string" } @@ -1278,6 +1288,7 @@ "GKE_CLUSTER_NOT_RUNNING", "CLOUD_SQL_INSTANCE_NOT_RUNNING", "REDIS_INSTANCE_NOT_RUNNING", + "REDIS_CLUSTER_NOT_RUNNING", "TRAFFIC_TYPE_BLOCKED", "GKE_MASTER_UNAUTHORIZED_ACCESS", "CLOUD_SQL_INSTANCE_UNAUTHORIZED_ACCESS", @@ -1317,7 +1328,20 @@ "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", "LOAD_BALANCER_BACKEND_INVALID_NETWORK", "BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED", - "DESTINATION_IS_PRIVATE_NAT_IP_RANGE" + "DESTINATION_IS_PRIVATE_NAT_IP_RANGE", + "DROPPED_INSIDE_REDIS_INSTANCE_SERVICE", + "REDIS_INSTANCE_UNSUPPORTED_PORT", + "REDIS_INSTANCE_CONNECTING_FROM_PUPI_ADDRESS", + "REDIS_INSTANCE_NO_ROUTE_TO_DESTINATION_NETWORK", + "REDIS_INSTANCE_NO_EXTERNAL_IP", + "REDIS_INSTANCE_UNSUPPORTED_PROTOCOL", + "DROPPED_INSIDE_REDIS_CLUSTER_SERVICE", + "REDIS_CLUSTER_UNSUPPORTED_PORT", + "REDIS_CLUSTER_NO_EXTERNAL_IP", + "REDIS_CLUSTER_UNSUPPORTED_PROTOCOL", + "NO_ADVERTISED_ROUTE_TO_GCP_DESTINATION", + "NO_TRAFFIC_SELECTOR_TO_GCP_DESTINATION", + "NO_KNOWN_ROUTE_FROM_PEERED_NETWORK_TO_DESTINATION" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1349,6 +1373,7 @@ "Packet sent from or to a GKE cluster that is not in running state.", "Packet sent from or to a Cloud SQL instance that is not in running state.", "Packet sent from or to a Redis Instance that is not in running state.", + "Packet sent from or to a Redis Cluster that is not in running state.", "The type of traffic is blocked and the user cannot configure a firewall rule to enable it. See [Always blocked traffic](https://cloud.google.com/vpc/docs/firewalls#blockedtraffic) for more details.", "Access to Google Kubernetes Engine cluster master's endpoint is not authorized. See [Access to the cluster endpoints](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#access_to_the_cluster_endpoints) for more details.", "Access to the Cloud SQL instance endpoint is not authorized. See [Authorizing with authorized networks](https://cloud.google.com/sql/docs/mysql/authorize-networks) for more details.", @@ -1388,7 +1413,20 @@ "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", "Packet is dropped due to a backend service named port not being defined on the instance group level.", - "Packet is dropped due to a destination IP range being part of a Private NAT IP range." + "Packet is dropped due to a destination IP range being part of a Private NAT IP range.", + "Generic drop cause for a packet being dropped inside a Redis Instance service project.", + "Packet is dropped due to an unsupported port being used to connect to a Redis Instance. Port 6379 should be used to connect to a Redis Instance.", + "Packet is dropped due to connecting from PUPI address to a PSA based Redis Instance.", + "Packet is dropped due to no route to the destination network.", + "Redis Instance does not have an external IP address.", + "Packet is dropped due to an unsupported protocol being used to connect to a Redis Instance. Only TCP connections are accepted by a Redis Instance.", + "Generic drop cause for a packet being dropped inside a Redis Cluster service project.", + "Packet is dropped due to an unsupported port being used to connect to a Redis Cluster. Ports 6379 and 11000 to 13047 should be used to connect to a Redis Cluster.", + "Redis Cluster does not have an external IP address.", + "Packet is dropped due to an unsupported protocol being used to connect to a Redis Cluster. Only TCP connections are accepted by a Redis Cluster.", + "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." ], "type": "string" }, @@ -2303,7 +2341,7 @@ "type": "object" }, "NetworkInfo": { - "description": "For display only. Metadata associated with a Compute Engine network.", + "description": "For display only. Metadata associated with a Compute Engine network. Next ID: 7", "id": "NetworkInfo", "properties": { "displayName": { @@ -2311,7 +2349,15 @@ "type": "string" }, "matchedIpRange": { - "description": "The IP range that matches the test.", + "description": "The IP range of the subnet matching the source IP address of the test.", + "type": "string" + }, + "matchedSubnetUri": { + "description": "URI of the subnet matching the source IP address of the test.", + "type": "string" + }, + "region": { + "description": "The region of the subnet matching the source IP address of the test.", "type": "string" }, "uri": { @@ -2590,6 +2636,37 @@ }, "type": "object" }, + "RedisClusterInfo": { + "description": "For display only. Metadata associated with a Redis Cluster.", + "id": "RedisClusterInfo", + "properties": { + "discoveryEndpointIpAddress": { + "description": "Discovery endpoint IP address of a Redis Cluster.", + "type": "string" + }, + "displayName": { + "description": "Name of a Redis Cluster.", + "type": "string" + }, + "location": { + "description": "Name of the region in which the Redis Cluster is defined. For example, \"us-central1\".", + "type": "string" + }, + "networkUri": { + "description": "URI of a Redis Cluster network in format \"projects/{project_id}/global/networks/{network_id}\".", + "type": "string" + }, + "secondaryEndpointIpAddress": { + "description": "Secondary endpoint IP address of a Redis Cluster.", + "type": "string" + }, + "uri": { + "description": "URI of a Redis Cluster in format \"projects/{project_id}/locations/{location}/clusters/{cluster_id}\"", + "type": "string" + } + }, + "type": "object" + }, "RedisInstanceInfo": { "description": "For display only. Metadata associated with a Cloud Redis Instance.", "id": "RedisInstanceInfo", @@ -2631,6 +2708,14 @@ "description": "For display only. Metadata associated with a Compute Engine route.", "id": "RouteInfo", "properties": { + "advertisedRouteNextHopUri": { + "description": "For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.", + "type": "string" + }, + "advertisedRouteSourceRouterUri": { + "description": "For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.", + "type": "string" + }, "destIpRange": { "description": "Destination IP range of the route.", "type": "string" @@ -2715,6 +2800,10 @@ }, "type": "array" }, + "region": { + "description": "Region of the route (if applicable).", + "type": "string" + }, "routeScope": { "description": "Indicates where route is applicable.", "enum": [ @@ -2739,7 +2828,8 @@ "PEERING_SUBNET", "PEERING_STATIC", "PEERING_DYNAMIC", - "POLICY_BASED" + "POLICY_BASED", + "ADVERTISED" ], "enumDescriptions": [ "Unspecified type. Default value.", @@ -2749,7 +2839,8 @@ "A subnet route received from peering network.", "A static route received from peering network.", "A dynamic route received from peering network.", - "Policy based route." + "Policy based route.", + "Advertised route. Synthetic route which is used to transition from the StartFromPrivateNetwork state in Connectivity tests." ], "type": "string" }, @@ -2765,7 +2856,7 @@ "type": "array" }, "uri": { - "description": "URI of a route. Dynamic, peering static and peering dynamic routes do not have an URI. Advertised route from Google Cloud VPC to on-premises network also does not have an URI.", + "description": "URI of a route (if applicable).", "type": "string" } }, @@ -2918,6 +3009,10 @@ "$ref": "ProxyConnectionInfo", "description": "Display information of a ProxyConnection." }, + "redisCluster": { + "$ref": "RedisClusterInfo", + "description": "Display information of a Redis Cluster." + }, "redisInstance": { "$ref": "RedisInstanceInfo", "description": "Display information of a Redis Instance." @@ -2941,6 +3036,7 @@ "START_FROM_GKE_MASTER", "START_FROM_CLOUD_SQL_INSTANCE", "START_FROM_REDIS_INSTANCE", + "START_FROM_REDIS_CLUSTER", "START_FROM_CLOUD_FUNCTION", "START_FROM_APP_ENGINE_VERSION", "START_FROM_CLOUD_RUN_REVISION", @@ -2989,6 +3085,7 @@ false, false, false, + false, true, true, false, @@ -3011,6 +3108,7 @@ "Initial state: packet originating from a Google Kubernetes Engine cluster master. A GKEMasterInfo is populated with starting instance information.", "Initial state: packet originating from a Cloud SQL instance. A CloudSQLInstanceInfo is populated with starting instance information.", "Initial state: packet originating from a Redis instance. A RedisInstanceInfo is populated with starting instance information.", + "Initial state: packet originating from a Redis Cluster. A RedisClusterInfo is populated with starting Cluster information.", "Initial state: packet originating from a Cloud Function. A CloudFunctionInfo is populated with starting function information.", "Initial state: packet originating from an App Engine service version. An AppEngineVersionInfo is populated with starting version information.", "Initial state: packet originating from a Cloud Run revision. A CloudRunRevisionInfo is populated with starting revision information.", diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index 7f4ed330cc..294e3d25fa 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -3253,7 +3253,7 @@ } } }, - "revision": "20240803", + "revision": "20240919", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3492,6 +3492,17 @@ }, "type": "object" }, + "CustomMirroringProfile": { + "description": "CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup", + "id": "CustomMirroringProfile", + "properties": { + "mirroringEndpointGroup": { + "description": "Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.", + "type": "string" + } + }, + "type": "object" + }, "Destination": { "description": "Specification of traffic destination attributes.", "id": "Destination", @@ -3678,14 +3689,16 @@ "CREATING", "ACTIVE", "DELETING", - "INACTIVE" + "INACTIVE", + "ORPHAN" ], "enumDescriptions": [ "Not set.", "Being created.", "Active and ready for traffic.", "Being deleted.", - "Down or in an error state." + "Down or in an error state.", + "The GCP project that housed the association has been deleted." ], "readOnly": true, "type": "string" @@ -4525,6 +4538,10 @@ "readOnly": true, "type": "string" }, + "customMirroringProfile": { + "$ref": "CustomMirroringProfile", + "description": "The custom Packet Mirroring v2 configuration for the SecurityProfile." + }, "description": { "description": "Optional. An optional description of the profile. Max length 512 characters.", "type": "string" @@ -4553,11 +4570,13 @@ "description": "Immutable. The single ProfileType that the SecurityProfile resource configures.", "enum": [ "PROFILE_TYPE_UNSPECIFIED", - "THREAT_PREVENTION" + "THREAT_PREVENTION", + "CUSTOM_MIRRORING" ], "enumDescriptions": [ "Profile type not specified.", - "Profile type for threat prevention." + "Profile type for threat prevention.", + "Profile type for packet mirroring v2" ], "type": "string" }, @@ -4580,6 +4599,10 @@ "readOnly": true, "type": "string" }, + "customMirroringProfile": { + "description": "Optional. Reference to a SecurityProfile with the CustomMirroring configuration.", + "type": "string" + }, "description": { "description": "Optional. An optional description of the profile group. Max length 2048 characters.", "type": "string" diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 65b952c5e6..52d5da96c5 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -1923,7 +1923,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "description": "Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2740,6 +2740,734 @@ } } }, + "mirroringDeploymentGroups": { + "methods": { + "create": { + "description": "Creates a new MirroringDeploymentGroup in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mirroringDeploymentGroupId": { + "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringDeploymentGroups", + "request": { + "$ref": "MirroringDeploymentGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single MirroringDeploymentGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single MirroringDeploymentGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "MirroringDeploymentGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MirroringDeploymentGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.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 ListMirroringDeploymentGroupsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringDeploymentGroups", + "response": { + "$ref": "ListMirroringDeploymentGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single MirroringDeploymentGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeploymentGroups/{mirroringDeploymentGroupsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringDeploymentGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeploymentGroups/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeploymentGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "MirroringDeploymentGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "mirroringDeployments": { + "methods": { + "create": { + "description": "Creates a new MirroringDeployment in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.mirroringDeployments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mirroringDeploymentId": { + "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringDeployments", + "request": { + "$ref": "MirroringDeployment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single MirroringDeployment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringDeployments.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single MirroringDeployment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringDeployments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "MirroringDeployment" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MirroringDeployments in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringDeployments.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 ListMirroringDeploymentsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringDeployments", + "response": { + "$ref": "ListMirroringDeploymentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single MirroringDeployment.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringDeployments/{mirroringDeploymentsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringDeployments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The name of the MirroringDeployment.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringDeployments/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringDeployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "MirroringDeployment" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "mirroringEndpointGroupAssociations": { + "methods": { + "create": { + "description": "Creates a new MirroringEndpointGroupAssociation in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mirroringEndpointGroupAssociationId": { + "description": "Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringEndpointGroupAssociations", + "request": { + "$ref": "MirroringEndpointGroupAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single MirroringEndpointGroupAssociation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single MirroringEndpointGroupAssociation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "MirroringEndpointGroupAssociation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MirroringEndpointGroupAssociations in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.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 ListMirroringEndpointGroupAssociationsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringEndpointGroupAssociations", + "response": { + "$ref": "ListMirroringEndpointGroupAssociationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single MirroringEndpointGroupAssociation.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroupAssociations/{mirroringEndpointGroupAssociationsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringEndpointGroupAssociations.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroupAssociations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroupAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "MirroringEndpointGroupAssociation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "mirroringEndpointGroups": { + "methods": { + "create": { + "description": "Creates a new MirroringEndpointGroup in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "mirroringEndpointGroupId": { + "description": "Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringEndpointGroups", + "request": { + "$ref": "MirroringEndpointGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single MirroringEndpointGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single MirroringEndpointGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "MirroringEndpointGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists MirroringEndpointGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.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 ListMirroringEndpointGroupsRequest", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/mirroringEndpointGroups", + "response": { + "$ref": "ListMirroringEndpointGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a single MirroringEndpointGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/mirroringEndpointGroups/{mirroringEndpointGroupsId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.mirroringEndpointGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The name of the MirroringEndpointGroup.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/mirroringEndpointGroups/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the MirroringEndpointGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "MirroringEndpointGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -3431,7 +4159,7 @@ } } }, - "revision": "20240803", + "revision": "20240919", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3594,7 +4322,7 @@ "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.", + "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", @@ -3617,14 +4345,14 @@ }, "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": "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.", + "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" }, @@ -3685,7 +4413,7 @@ "type": "array" }, "sources": { - "description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", + "description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 5 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", "items": { "$ref": "AuthzPolicyAuthzRuleFromRequestSource" }, @@ -3699,14 +4427,14 @@ "id": "AuthzPolicyAuthzRuleFromRequestSource", "properties": { "principals": { - "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.", + "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 5 principals.", "items": { "$ref": "AuthzPolicyAuthzRuleStringMatch" }, "type": "array" }, "resources": { - "description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.", + "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" }, @@ -3750,7 +4478,7 @@ "id": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", "properties": { "ids": { - "description": "Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.", + "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" @@ -3799,7 +4527,7 @@ "type": "array" }, "operations": { - "description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", + "description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 5 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", "items": { "$ref": "AuthzPolicyAuthzRuleToRequestOperation" }, @@ -3817,7 +4545,7 @@ "description": "Optional. A list of headers to match against in http header." }, "hosts": { - "description": "Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", + "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" }, @@ -3831,7 +4559,7 @@ "type": "array" }, "paths": { - "description": "Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", + "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" }, @@ -3845,7 +4573,7 @@ "id": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", "properties": { "headers": { - "description": "Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", + "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" }, @@ -3894,7 +4622,7 @@ "id": "AuthzPolicyTarget", "properties": { "loadBalancingScheme": { - "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "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": [ "LOAD_BALANCING_SCHEME_UNSPECIFIED", "INTERNAL_MANAGED", @@ -4000,6 +4728,17 @@ }, "type": "object" }, + "CustomMirroringProfile": { + "description": "CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup", + "id": "CustomMirroringProfile", + "properties": { + "mirroringEndpointGroup": { + "description": "Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored.", + "type": "string" + } + }, + "type": "object" + }, "Destination": { "description": "Specification of traffic destination attributes.", "id": "Destination", @@ -4186,14 +4925,16 @@ "CREATING", "ACTIVE", "DELETING", - "INACTIVE" + "INACTIVE", + "ORPHAN" ], "enumDescriptions": [ "Not set.", "Being created.", "Active and ready for traffic.", "Being deleted.", - "Down or in an error state." + "Down or in an error state.", + "The GCP project that housed the association has been deleted." ], "readOnly": true, "type": "string" @@ -4678,15 +5419,101 @@ "description": "Response returned by the ListGatewaySecurityPolicies method.", "id": "ListGatewaySecurityPoliciesResponse", "properties": { - "gatewaySecurityPolicies": { - "description": "List of GatewaySecurityPolicies resources.", + "gatewaySecurityPolicies": { + "description": "List of GatewaySecurityPolicies resources.", + "items": { + "$ref": "GatewaySecurityPolicy" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListGatewaySecurityPolicyRulesResponse": { + "description": "Response returned by the ListGatewaySecurityPolicyRules method.", + "id": "ListGatewaySecurityPolicyRulesResponse", + "properties": { + "gatewaySecurityPolicyRules": { + "description": "List of GatewaySecurityPolicyRule resources.", + "items": { + "$ref": "GatewaySecurityPolicyRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListMirroringDeploymentGroupsResponse": { + "description": "Message for response to listing MirroringDeploymentGroups", + "id": "ListMirroringDeploymentGroupsResponse", + "properties": { + "mirroringDeploymentGroups": { + "description": "The list of MirroringDeploymentGroup", + "items": { + "$ref": "MirroringDeploymentGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListMirroringDeploymentsResponse": { + "description": "Message for response to listing MirroringDeployments", + "id": "ListMirroringDeploymentsResponse", + "properties": { + "mirroringDeployments": { + "description": "The list of MirroringDeployment", "items": { - "$ref": "GatewaySecurityPolicy" + "$ref": "MirroringDeployment" }, "type": "array" }, "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "description": "A token identifying a page of results the server should return.", "type": "string" }, "unreachable": { @@ -4699,44 +5526,37 @@ }, "type": "object" }, - "ListGatewaySecurityPolicyRulesResponse": { - "description": "Response returned by the ListGatewaySecurityPolicyRules method.", - "id": "ListGatewaySecurityPolicyRulesResponse", + "ListMirroringEndpointGroupAssociationsResponse": { + "description": "Message for response to listing MirroringEndpointGroupAssociations", + "id": "ListMirroringEndpointGroupAssociationsResponse", "properties": { - "gatewaySecurityPolicyRules": { - "description": "List of GatewaySecurityPolicyRule resources.", + "mirroringEndpointGroupAssociations": { + "description": "The list of MirroringEndpointGroupAssociation", "items": { - "$ref": "GatewaySecurityPolicyRule" + "$ref": "MirroringEndpointGroupAssociation" }, "type": "array" }, "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then 'next_page_token' is included. To get the next set of results, call this method again using the value of 'next_page_token' as 'page_token'.", + "description": "A token identifying a page of results the server should return.", "type": "string" - }, - "unreachable": { - "description": "Locations that could not be reached.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "id": "ListLocationsResponse", + "ListMirroringEndpointGroupsResponse": { + "description": "Message for response to listing MirroringEndpointGroups", + "id": "ListMirroringEndpointGroupsResponse", "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", + "mirroringEndpointGroups": { + "description": "The list of MirroringEndpointGroup", "items": { - "$ref": "Location" + "$ref": "MirroringEndpointGroup" }, "type": "array" }, "nextPageToken": { - "description": "The standard List next-page token.", + "description": "A token identifying a page of results the server should return.", "type": "string" } }, @@ -4930,6 +5750,309 @@ }, "type": "object" }, + "MirroringDeployment": { + "description": "Message describing MirroringDeployment object", + "id": "MirroringDeployment", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "forwardingRule": { + "description": "Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project}/regions/{region}/forwardingRules/{forwardingRule}", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "mirroringDeploymentGroup": { + "description": "Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The name of the MirroringDeployment.", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. Current state of the deployment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "Not set.", + "Ready.", + "Being created.", + "Being deleted.", + "The underlying data plane is out of sync with the deployment. The deployment is not expected to be usable. This state can result in undefined behavior.", + "An attempt to delete the deployment has failed. This is a terminal state and the deployment is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the deployment." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringDeploymentGroup": { + "description": "Message describing MirroringDeploymentGroup object", + "id": "MirroringDeploymentGroup", + "properties": { + "connectedEndpointGroups": { + "description": "Output only. The list of Mirroring Endpoint Groups that are connected to this resource.", + "items": { + "$ref": "MirroringDeploymentGroupConnectedEndpointGroup" + }, + "readOnly": true, + "type": "array" + }, + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "name": { + "description": "Immutable. Identifier. Then name of the MirroringDeploymentGroup.", + "type": "string" + }, + "network": { + "description": "Required. Immutable. The network that is being used for the deployment. Format is: projects/{project}/global/networks/{network}.", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. Current state of the deployment group.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "DELETING" + ], + "enumDescriptions": [ + "Not set.", + "Ready.", + "Being created.", + "Being deleted." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringDeploymentGroupConnectedEndpointGroup": { + "description": "An endpoint group connected to this deployment group.", + "id": "MirroringDeploymentGroupConnectedEndpointGroup", + "properties": { + "name": { + "description": "Output only. A connected mirroring endpoint group.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringEndpointGroup": { + "description": "Message describing MirroringEndpointGroup object. Next ID: 10", + "id": "MirroringEndpointGroup", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "mirroringDeploymentGroup": { + "description": "Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup}`", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The name of the MirroringEndpointGroup.", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128.", + "readOnly": true, + "type": "boolean" + }, + "state": { + "description": "Output only. Current state of the endpoint group.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CLOSED", + "CREATING", + "DELETING", + "OUT_OF_SYNC", + "DELETE_FAILED" + ], + "enumDescriptions": [ + "Not set.", + "Ready.", + "The deployment group has been deleted and mirroring is disabled.", + "Being created.", + "Being deleted.", + "The underlying data plane is out of sync with the endpoint group. Some associations might not be usable.", + "An attempt to delete the endpoint group has failed. This is a terminal state and the endpoint group is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the endpoint group." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringEndpointGroupAssociation": { + "description": "Message describing MirroringEndpointGroupAssociation object", + "id": "MirroringEndpointGroupAssociation", + "properties": { + "createTime": { + "description": "Output only. [Output only] Create time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels as key value pairs", + "type": "object" + }, + "locationsDetails": { + "description": "Output only. The list of locations that this association is in and its details.", + "items": { + "$ref": "MirroringEndpointGroupAssociationLocationDetails" + }, + "readOnly": true, + "type": "array" + }, + "mirroringEndpointGroup": { + "description": "Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup}`", + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The name of the MirroringEndpointGroupAssociation.", + "type": "string" + }, + "network": { + "description": "Required. Immutable. The VPC network associated. Format: projects/{project}/global/networks/{network}.", + "type": "string" + }, + "reconciling": { + "description": "Output only. Whether reconciling is in progress, recommended per 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.", + "Ready.", + "Being created.", + "Being deleted.", + "Mirroring is disabled due to an operation on another resource.", + "The underlying data plane is out of sync with the association. The association is not expected to be usable. This state can result in undefined behavior. See the `locations_details` field for more details.", + "An attempt to delete the association has failed. This is a terminal state and the association is not expected to be usable as some of its resources have been deleted. The only permitted operation is to retry deleting the association." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. [Output only] Update time stamp", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MirroringEndpointGroupAssociationLocationDetails": { + "description": "Details about the association status in a specific cloud location.", + "id": "MirroringEndpointGroupAssociationLocationDetails", + "properties": { + "location": { + "description": "Output only. The cloud location.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The association state in this location.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "OUT_OF_SYNC" + ], + "enumDescriptions": [ + "Not set.", + "Ready.", + "The data plane is out of sync with the association in this location." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -5058,6 +6181,10 @@ "readOnly": true, "type": "string" }, + "customMirroringProfile": { + "$ref": "CustomMirroringProfile", + "description": "The custom Packet Mirroring v2 configuration for the SecurityProfile." + }, "description": { "description": "Optional. An optional description of the profile. Max length 512 characters.", "type": "string" @@ -5086,11 +6213,13 @@ "description": "Immutable. The single ProfileType that the SecurityProfile resource configures.", "enum": [ "PROFILE_TYPE_UNSPECIFIED", - "THREAT_PREVENTION" + "THREAT_PREVENTION", + "CUSTOM_MIRRORING" ], "enumDescriptions": [ "Profile type not specified.", - "Profile type for threat prevention." + "Profile type for threat prevention.", + "Profile type for packet mirroring v2" ], "type": "string" }, @@ -5113,6 +6242,10 @@ "readOnly": true, "type": "string" }, + "customMirroringProfile": { + "description": "Optional. Reference to a SecurityProfile with the CustomMirroring configuration.", + "type": "string" + }, "description": { "description": "Optional. An optional description of the profile group. Max length 2048 characters.", "type": "string" diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 90beaff2e7..e8d54dca56 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -1241,7 +1241,7 @@ "type": "string" }, "updateMask": { - "description": "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.", + "description": "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.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1423,7 +1423,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "description": "Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1930,37 +1930,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceLbPolicies in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies", @@ -2030,62 +1999,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2408,7 +2321,7 @@ } } }, - "revision": "20240818", + "revision": "20240919", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -3759,7 +3672,7 @@ "type": "object" }, "loadBalancingScheme": { - "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `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", @@ -3829,7 +3742,7 @@ "type": "object" }, "loadBalancingScheme": { - "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `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", @@ -4152,6 +4065,41 @@ }, "type": "object" }, + "LoggingConfig": { + "description": "The configuration for Platform Telemetry logging for Eventarc Avdvanced resources.", + "id": "LoggingConfig", + "properties": { + "logSeverity": { + "description": "Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.", + "enum": [ + "LOG_SEVERITY_UNSPECIFIED", + "NONE", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "Log severity is not specified. This value is treated the same as NONE, but is used to distinguish between no update and update to NONE in update_masks.", + "Default value at resource creation, presence of this value must be treated as no logging/disable logging.", + "Debug or trace level logging.", + "Routine information, such as ongoing status or performance.", + "Normal but significant events, such as start up, shut down, or a configuration change.", + "Warning events might cause problems.", + "Error events are likely to cause problems.", + "Critical events cause more severe problems or outages.", + "A person must take action immediately.", + "One or more systems are unusable." + ], + "type": "string" + } + }, + "type": "object" + }, "Mesh": { "description": "Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary.", "id": "Mesh", @@ -4320,6 +4268,16 @@ }, "type": "object" }, + "RetryFilterPerRouteConfig": { + "id": "RetryFilterPerRouteConfig", + "properties": { + "cryptoKeyName": { + "description": "The name of the crypto key to use for encrypting event data.", + "type": "string" + } + }, + "type": "object" + }, "ServiceBinding": { "description": "ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource.", "id": "ServiceBinding", diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 86a4cba793..127e7e9fb3 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -340,7 +340,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "description": "Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1150,7 +1150,7 @@ "type": "string" }, "updateMask": { - "description": "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.", + "description": "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.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1332,7 +1332,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "description": "Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1839,37 +1839,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceLbPolicies in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies", @@ -1939,62 +1908,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceLbPolicies/{serviceLbPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceLbPolicies.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/[^/]+/serviceLbPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2317,59 +2230,11 @@ } } }, - "revision": "20240818", + "revision": "20240919", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { - "AuditConfig": { - "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", - "id": "AuditConfig", - "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", - "items": { - "$ref": "AuditLogConfig" - }, - "type": "array" - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", - "type": "string" - } - }, - "type": "object" - }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", - "id": "AuditLogConfig", - "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", - "items": { - "type": "string" - }, - "type": "array" - }, - "logType": { - "description": "The log type that this config enables.", - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ], - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], - "type": "string" - } - }, - "type": "object" - }, "AuthzExtension": { - "description": "`AuthzExtension` is a resource that allows traffic forwarding to a callout backend to make an authorization decision.", + "description": "`AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision.", "id": "AuthzExtension", "properties": { "authority": { @@ -2405,7 +2270,7 @@ "type": "object" }, "loadBalancingScheme": { - "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `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", @@ -2431,7 +2296,7 @@ "type": "string" }, "service": { - "description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", + "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}`.", "type": "string" }, "timeout": { @@ -2460,28 +2325,6 @@ }, "type": "object" }, - "Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "Binding", - "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." - }, - "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", - "type": "string" - } - }, - "type": "object" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -2573,29 +2416,6 @@ }, "type": "object" }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", - "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", - "type": "string" - }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", - "type": "string" - }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", - "type": "string" - } - }, - "type": "object" - }, "ExtensionChain": { "description": "A single extension chain wrapper that contains the match conditions and extensions to execute.", "id": "ExtensionChain", @@ -3717,7 +3537,7 @@ "type": "object" }, "loadBalancingScheme": { - "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `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", @@ -3787,7 +3607,7 @@ "type": "object" }, "loadBalancingScheme": { - "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `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", @@ -4135,6 +3955,41 @@ }, "type": "object" }, + "LoggingConfig": { + "description": "The configuration for Platform Telemetry logging for Eventarc Avdvanced resources.", + "id": "LoggingConfig", + "properties": { + "logSeverity": { + "description": "Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE.", + "enum": [ + "LOG_SEVERITY_UNSPECIFIED", + "NONE", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "Log severity is not specified. This value is treated the same as NONE, but is used to distinguish between no update and update to NONE in update_masks.", + "Default value at resource creation, presence of this value must be treated as no logging/disable logging.", + "Debug or trace level logging.", + "Routine information, such as ongoing status or performance.", + "Normal but significant events, such as start up, shut down, or a configuration change.", + "Warning events might cause problems.", + "Error events are likely to cause problems.", + "Critical events cause more severe problems or outages.", + "A person must take action immediately.", + "One or more systems are unusable." + ], + "type": "string" + } + }, + "type": "object" + }, "Mesh": { "description": "Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary.", "id": "Mesh", @@ -4315,33 +4170,12 @@ }, "type": "object" }, - "Policy": { - "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", - "id": "Policy", + "RetryFilterPerRouteConfig": { + "id": "RetryFilterPerRouteConfig", "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "items": { - "$ref": "AuditConfig" - }, - "type": "array" - }, - "bindings": { - "description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.", - "items": { - "$ref": "Binding" - }, - "type": "array" - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.", - "format": "byte", + "cryptoKeyName": { + "description": "The name of the crypto key to use for encrypting event data.", "type": "string" - }, - "version": { - "description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "type": "integer" } }, "type": "object" @@ -4472,22 +4306,6 @@ }, "type": "object" }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "id": "SetIamPolicyRequest", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them." - }, - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: \"bindings, etag\"`", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -4647,34 +4465,6 @@ }, "type": "object" }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "id": "TestIamPermissionsRequest", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "id": "TestIamPermissionsResponse", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "TlsRoute": { "description": "TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes.", "id": "TlsRoute", diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index c345367ddf..de29e90a32 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -2008,7 +2008,7 @@ } } }, - "revision": "20240820", + "revision": "20240918", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2822,7 +2822,7 @@ "type": "string" }, "tags": { - "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).", + "description": "Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "items": { "type": "string" }, @@ -4561,7 +4561,7 @@ "type": "string" }, "tags": { - "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).", + "description": "Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "items": { "type": "string" }, diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index acc2ba31ed..1a99f852ee 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -904,7 +904,7 @@ } } }, - "revision": "20240820", + "revision": "20240918", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1357,7 +1357,7 @@ "description": "Optional. Shielded VM configuration. [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm)." }, "tags": { - "description": "Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).", + "description": "Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)).", "items": { "type": "string" }, diff --git a/discovery/oracledatabase-v1.json b/discovery/oracledatabase-v1.json new file mode 100644 index 0000000000..8f3cc2636d --- /dev/null +++ b/discovery/oracledatabase-v1.json @@ -0,0 +1,3764 @@ +{ + "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://oracledatabase.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Oracle Database", + "description": "The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/oracle/database/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": "oracledatabase:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://oracledatabase.mtls.googleapis.com/", + "name": "oracledatabase", + "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": "oracledatabase.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": "oracledatabase.projects.locations.list", + "parameterOrder": [ + "name" + ], + "parameters": { + "filter": { + "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", + "location": "query", + "type": "string" + }, + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return. If not set, the service selects a default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "autonomousDatabaseBackups": { + "methods": { + "list": { + "description": "Lists the long-term and automatic backups of an Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseBackups", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.autonomousDatabaseBackups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id=\"{autonomous_database_id}\"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/autonomousDatabaseBackups", + "response": { + "$ref": "ListAutonomousDatabaseBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "autonomousDatabaseCharacterSets": { + "methods": { + "list": { + "description": "Lists Autonomous Database Character Sets in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabaseCharacterSets", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.autonomousDatabaseCharacterSets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type=\"{characterSetType}\"`. Accepted values include `DATABASE` and `NATIONAL`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/autonomousDatabaseCharacterSets", + "response": { + "$ref": "ListAutonomousDatabaseCharacterSetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "autonomousDatabases": { + "methods": { + "create": { + "description": "Creates a new Autonomous Database in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.autonomousDatabases.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "autonomousDatabaseId": { + "description": "Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+parent}/autonomousDatabases", + "request": { + "$ref": "AutonomousDatabase" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.autonomousDatabases.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the resource in the following format: projects/{project}/locations/{location}/autonomousDatabases/{autonomous_database}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/autonomousDatabases/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateWallet": { + "description": "Generates a wallet for an Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:generateWallet", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.autonomousDatabases.generateWallet", + "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}:generateWallet", + "request": { + "$ref": "GenerateAutonomousDatabaseWalletRequest" + }, + "response": { + "$ref": "GenerateAutonomousDatabaseWalletResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a single Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.autonomousDatabases.get", + "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}", + "response": { + "$ref": "AutonomousDatabase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the Autonomous Databases in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.autonomousDatabases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An expression for ordering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/autonomousDatabases", + "response": { + "$ref": "ListAutonomousDatabasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restores a single Autonomous Database.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDatabases/{autonomousDatabasesId}:restore", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.autonomousDatabases.restore", + "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}:restore", + "request": { + "$ref": "RestoreAutonomousDatabaseRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "autonomousDbVersions": { + "methods": { + "list": { + "description": "Lists all the available Autonomous Database versions for a project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autonomousDbVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.autonomousDbVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for the Autonomous Database in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/autonomousDbVersions", + "response": { + "$ref": "ListAutonomousDbVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "cloudExadataInfrastructures": { + "methods": { + "create": { + "description": "Creates a new Exadata Infrastructure in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "cloudExadataInfrastructureId": { + "description": "Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+parent}/cloudExadataInfrastructures", + "request": { + "$ref": "CloudExadataInfrastructure" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Exadata Infrastructure.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Exadata Infrastructure.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CloudExadataInfrastructure" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Exadata Infrastructures in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cloudExadataInfrastructures", + "response": { + "$ref": "ListCloudExadataInfrastructuresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dbServers": { + "methods": { + "list": { + "description": "Lists the database servers of an Exadata Infrastructure instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudExadataInfrastructures/{cloudExadataInfrastructuresId}/dbServers", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudExadataInfrastructures.dbServers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "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 value for database server in the following format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloudExadataInfrastructure}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudExadataInfrastructures/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dbServers", + "response": { + "$ref": "ListDbServersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "cloudVmClusters": { + "methods": { + "create": { + "description": "Creates a new VM Cluster in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters", + "httpMethod": "POST", + "id": "oracledatabase.projects.locations.cloudVmClusters.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "cloudVmClusterId": { + "description": "Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+parent}/cloudVmClusters", + "request": { + "$ref": "CloudVmCluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single VM Cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", + "httpMethod": "DELETE", + "id": "oracledatabase.projects.locations.cloudVmClusters.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single VM Cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudVmClusters.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Cloud VM Cluster in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CloudVmCluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the VM Clusters in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudVmClusters.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying the page of results the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the parent in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cloudVmClusters", + "response": { + "$ref": "ListCloudVmClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dbNodes": { + "methods": { + "list": { + "description": "Lists the database nodes of a VM Cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/cloudVmClusters/{cloudVmClustersId}/dbNodes", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.cloudVmClusters.dbNodes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 db nodes 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 token identifying a page of results the node should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for database node in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloudVmCluster}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cloudVmClusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dbNodes", + "response": { + "$ref": "ListDbNodesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "dbSystemShapes": { + "methods": { + "list": { + "description": "Lists the database system shapes available for the project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbSystemShapes", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.dbSystemShapes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes 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 token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent value for Database System Shapes in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dbSystemShapes", + "response": { + "$ref": "ListDbSystemShapesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "entitlements": { + "methods": { + "list": { + "description": "Lists the entitlements in a given project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entitlements", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.entitlements.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000.", + "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 value for the entitlement in the following format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/entitlements", + "response": { + "$ref": "ListEntitlementsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "giVersions": { + "methods": { + "list": { + "description": "Lists all the valid Oracle Grid Infrastructure (GI) versions for the given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/giVersions", + "httpMethod": "GET", + "id": "oracledatabase.projects.locations.giVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.", + "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 value for Grid Infrastructure Version in the following format: Format: projects/{project}/locations/{location}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/giVersions", + "response": { + "$ref": "ListGiVersionsResponse" + }, + "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": "oracledatabase.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": "oracledatabase.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": "oracledatabase.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": "oracledatabase.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": "20240918", + "rootUrl": "https://oracledatabase.googleapis.com/", + "schemas": { + "AllConnectionStrings": { + "description": "A list of all connection strings that can be used to connect to the Autonomous Database.", + "id": "AllConnectionStrings", + "properties": { + "high": { + "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabase": { + "description": "Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/", + "id": "AutonomousDatabase", + "properties": { + "adminPassword": { + "description": "Optional. The password for the default ADMIN user.", + "type": "string" + }, + "cidr": { + "description": "Required. The subnet CIDR range for the Autonmous Database.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the Autonomous Database was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "database": { + "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" + }, + "displayName": { + "description": "Optional. The display name for the Autonomous Database. The name does not have to be unique within your project.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. The ID of the subscription entitlement associated with the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels or tags associated with the Autonomous Database.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database resource in the following format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "network": { + "description": "Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "properties": { + "$ref": "AutonomousDatabaseProperties", + "description": "Optional. The properties of the Autonomous Database." + } + }, + "type": "object" + }, + "AutonomousDatabaseApex": { + "description": "Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex", + "id": "AutonomousDatabaseApex", + "properties": { + "apexVersion": { + "description": "Output only. The Oracle APEX Application Development version.", + "readOnly": true, + "type": "string" + }, + "ordsVersion": { + "description": "Output only. The Oracle REST Data Services (ORDS) version.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseBackup": { + "description": "Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/", + "id": "AutonomousDatabaseBackup", + "properties": { + "autonomousDatabase": { + "description": "Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}", + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for the Backup. The name does not have to be unique.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. labels or tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project}/locations/{region}/autonomousDatabaseBackups/{autonomous_database_backup}", + "type": "string" + }, + "properties": { + "$ref": "AutonomousDatabaseBackupProperties", + "description": "Optional. Various properties of the backup." + } + }, + "type": "object" + }, + "AutonomousDatabaseBackupProperties": { + "description": "Properties of the Autonomous Database Backup resource.", + "id": "AutonomousDatabaseBackupProperties", + "properties": { + "availableTillTime": { + "description": "Output only. Timestamp until when the backup will be available.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "compartmentId": { + "description": "Output only. The OCID of the compartment.", + "readOnly": true, + "type": "string" + }, + "databaseSizeTb": { + "description": "Output only. The quantity of data in the database, in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "dbVersion": { + "description": "Output only. A valid Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. The date and time the backup completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "isAutomaticBackup": { + "description": "Output only. Indicates if the backup is automatic or user initiated.", + "readOnly": true, + "type": "boolean" + }, + "isLongTermBackup": { + "description": "Output only. Indicates if the backup is long term backup.", + "readOnly": true, + "type": "boolean" + }, + "isRestorable": { + "description": "Output only. Indicates if the backup can be used to restore the Autonomous Database.", + "readOnly": true, + "type": "boolean" + }, + "keyStoreId": { + "description": "Optional. The OCID of the key store of Oracle Vault.", + "type": "string" + }, + "keyStoreWallet": { + "description": "Optional. The wallet name for Oracle Key Vault.", + "type": "string" + }, + "kmsKeyId": { + "description": "Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.", + "type": "string" + }, + "kmsKeyVersionId": { + "description": "Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.", + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. Additional information about the current lifecycle state.", + "readOnly": true, + "type": "string" + }, + "lifecycleState": { + "description": "Output only. The lifecycle state of the backup.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "DELETED", + "FAILED", + "UPDATING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in creating state.", + "Indicates that the resource is in active state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in updating state." + ], + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "retentionPeriodDays": { + "description": "Optional. Retention period in days for the backup.", + "format": "int32", + "type": "integer" + }, + "sizeTb": { + "description": "Output only. The backup size in terabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "startTime": { + "description": "Output only. The date and time the backup started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the backup.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCREMENTAL", + "FULL", + "LONG_TERM" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Incremental backups.", + "Full backups.", + "Long term backups." + ], + "readOnly": true, + "type": "string" + }, + "vaultId": { + "description": "Optional. The OCID of the vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseCharacterSet": { + "description": "Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/", + "id": "AutonomousDatabaseCharacterSet", + "properties": { + "characterSet": { + "description": "Output only. The character set name for the Autonomous Database which is the ID in the resource name.", + "readOnly": true, + "type": "string" + }, + "characterSetType": { + "description": "Output only. The character set type for the Autonomous Database.", + "enum": [ + "CHARACTER_SET_TYPE_UNSPECIFIED", + "DATABASE", + "NATIONAL" + ], + "enumDescriptions": [ + "Character set type is not specified.", + "Character set type is set to database.", + "Character set type is set to national." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project}/locations/{region}/autonomousDatabaseCharacterSets/{autonomous_database_character_set}", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseConnectionStrings": { + "description": "The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings", + "id": "AutonomousDatabaseConnectionStrings", + "properties": { + "allConnectionStrings": { + "$ref": "AllConnectionStrings", + "description": "Output only. Returns all connection strings that can be used to connect to the Autonomous Database.", + "readOnly": true + }, + "dedicated": { + "description": "Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements.", + "readOnly": true, + "type": "string" + }, + "high": { + "description": "Output only. The database service provides the highest level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "low": { + "description": "Output only. The database service provides the least level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "medium": { + "description": "Output only. The database service provides a lower level of resources to each SQL statement.", + "readOnly": true, + "type": "string" + }, + "profiles": { + "description": "Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata.", + "items": { + "$ref": "DatabaseConnectionStringProfile" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "AutonomousDatabaseConnectionUrls": { + "description": "The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls", + "id": "AutonomousDatabaseConnectionUrls", + "properties": { + "apexUri": { + "description": "Output only. Oracle Application Express (APEX) URL.", + "readOnly": true, + "type": "string" + }, + "databaseTransformsUri": { + "description": "Output only. The URL of the Database Transforms for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "graphStudioUri": { + "description": "Output only. The URL of the Graph Studio for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningNotebookUri": { + "description": "Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "machineLearningUserManagementUri": { + "description": "Output only. The URL of Machine Learning user management the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "mongoDbUri": { + "description": "Output only. The URL of the MongoDB API for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ordsUri": { + "description": "Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "sqlDevWebUri": { + "description": "Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseProperties": { + "description": "The properties of an Autonomous Database.", + "id": "AutonomousDatabaseProperties", + "properties": { + "actualUsedDataStorageSizeTb": { + "description": "Output only. The amount of storage currently being used for user and system data, in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "allocatedStorageSizeTb": { + "description": "Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "apexDetails": { + "$ref": "AutonomousDatabaseApex", + "description": "Output only. The details for the Oracle APEX Application Development.", + "readOnly": true + }, + "arePrimaryAllowlistedIpsUsed": { + "description": "Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary.", + "readOnly": true, + "type": "boolean" + }, + "autonomousContainerDatabaseId": { + "description": "Output only. The Autonomous Container Database OCID.", + "readOnly": true, + "type": "string" + }, + "availableUpgradeVersions": { + "description": "Output only. The list of available Oracle Database upgrade versions for an Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "backupRetentionPeriodDays": { + "description": "Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days.", + "format": "int32", + "type": "integer" + }, + "characterSet": { + "description": "Optional. The character set for the Autonomous Database. The default is AL32UTF8.", + "type": "string" + }, + "computeCount": { + "description": "Optional. The number of compute servers for the Autonomous Database.", + "format": "float", + "type": "number" + }, + "connectionStrings": { + "$ref": "AutonomousDatabaseConnectionStrings", + "description": "Output only. The connection strings used to connect to an Autonomous Database.", + "readOnly": true + }, + "connectionUrls": { + "$ref": "AutonomousDatabaseConnectionUrls", + "description": "Output only. The Oracle Connection URLs for an Autonomous Database.", + "readOnly": true + }, + "cpuCoreCount": { + "description": "Optional. The number of CPU cores to be made available to the database.", + "format": "int32", + "type": "integer" + }, + "customerContacts": { + "description": "Optional. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataSafeState": { + "description": "Output only. The current state of the Data Safe registration for the Autonomous Database.", + "enum": [ + "DATA_SAFE_STATE_UNSPECIFIED", + "REGISTERING", + "REGISTERED", + "DEREGISTERING", + "NOT_REGISTERED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Registering data safe state.", + "Registered data safe state.", + "Deregistering data safe state.", + "Not registered data safe state.", + "Failed data safe state." + ], + "readOnly": true, + "type": "string" + }, + "dataStorageSizeGb": { + "description": "Optional. The size of the data stored in the database, in gigabytes.", + "format": "int32", + "type": "integer" + }, + "dataStorageSizeTb": { + "description": "Optional. The size of the data stored in the database, in terabytes.", + "format": "int32", + "type": "integer" + }, + "databaseManagementState": { + "description": "Output only. The current state of database management for the Autonomous Database.", + "enum": [ + "DATABASE_MANAGEMENT_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling Database Management state", + "Enabled Database Management state", + "Disabling Database Management state", + "Not Enabled Database Management state", + "Failed enabling Database Management state", + "Failed disabling Database Management state" + ], + "readOnly": true, + "type": "string" + }, + "dbEdition": { + "description": "Optional. The edition of the Autonomous Databases.", + "enum": [ + "DATABASE_EDITION_UNSPECIFIED", + "STANDARD_EDITION", + "ENTERPRISE_EDITION" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Standard Database Edition", + "Enterprise Database Edition" + ], + "type": "string" + }, + "dbVersion": { + "description": "Optional. The Oracle Database version for the Autonomous Database.", + "type": "string" + }, + "dbWorkload": { + "description": "Required. The workload type of the Autonomous Database.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "type": "string" + }, + "failedDataRecoveryDuration": { + "description": "Output only. This field indicates the number of seconds of data loss during a Data Guard failover.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "isAutoScalingEnabled": { + "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count.", + "type": "boolean" + }, + "isLocalDataGuardEnabled": { + "description": "Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled.", + "readOnly": true, + "type": "boolean" + }, + "isStorageAutoScalingEnabled": { + "description": "Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage.", + "type": "boolean" + }, + "licenseType": { + "description": "Required. The license type used for the Autonomous Database.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. The details of the current lifestyle state of the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "localAdgAutoFailoverMaxDataLossLimit": { + "description": "Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "localDisasterRecoveryType": { + "description": "Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database.", + "enum": [ + "LOCAL_DISASTER_RECOVERY_TYPE_UNSPECIFIED", + "ADG", + "BACKUP_BASED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Data Guard recovery.", + "Backup based recovery." + ], + "readOnly": true, + "type": "string" + }, + "localStandbyDb": { + "$ref": "AutonomousDatabaseStandbySummary", + "description": "Output only. The details of the Autonomous Data Guard standby database.", + "readOnly": true + }, + "maintenanceBeginTime": { + "description": "Output only. The date and time when maintenance will begin.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceEndTime": { + "description": "Output only. The date and time when maintenance will end.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "maintenanceScheduleType": { + "description": "Optional. The maintenance schedule of the Autonomous Database.", + "enum": [ + "MAINTENANCE_SCHEDULE_TYPE_UNSPECIFIED", + "EARLY", + "REGULAR" + ], + "enumDescriptions": [ + "Default unspecified value.", + "An EARLY maintenance schedule patches the database before the regular scheduled maintenance.", + "A REGULAR maintenance schedule follows the normal maintenance cycle." + ], + "type": "string" + }, + "memoryPerOracleComputeUnitGbs": { + "description": "Output only. The amount of memory enabled per ECPU, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memoryTableGbs": { + "description": "Output only. The memory assigned to in-memory tables in an Autonomous Database.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "mtlsConnectionRequired": { + "description": "Optional. This field specifies if the Autonomous Database requires mTLS connections.", + "type": "boolean" + }, + "nCharacterSet": { + "description": "Optional. The national character set for the Autonomous Database. The default is AL16UTF16.", + "type": "string" + }, + "nextLongTermBackupTime": { + "description": "Output only. The long term backup schedule of the Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ociUrl": { + "description": "Output only. The Oracle Cloud Infrastructure link for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "openMode": { + "description": "Output only. This field indicates the current mode of the Autonomous Database.", + "enum": [ + "OPEN_MODE_UNSPECIFIED", + "READ_ONLY", + "READ_WRITE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Read Only Mode", + "Read Write Mode" + ], + "readOnly": true, + "type": "string" + }, + "operationsInsightsState": { + "description": "Output only. This field indicates the state of Operations Insights for the Autonomous Database.", + "enum": [ + "OPERATIONS_INSIGHTS_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "NOT_ENABLED", + "FAILED_ENABLING", + "FAILED_DISABLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Enabling status for operation insights.", + "Enabled status for operation insights.", + "Disabling status for operation insights.", + "Not Enabled status for operation insights.", + "Failed enabling status for operation insights.", + "Failed disabling status for operation insights." + ], + "readOnly": true, + "type": "string" + }, + "peerDbIds": { + "description": "Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "permissionLevel": { + "description": "Output only. The permission level of the Autonomous Database.", + "enum": [ + "PERMISSION_LEVEL_UNSPECIFIED", + "RESTRICTED", + "UNRESTRICTED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Restricted mode allows access only by admin users.", + "Normal access." + ], + "readOnly": true, + "type": "string" + }, + "privateEndpoint": { + "description": "Output only. The private endpoint for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "privateEndpointIp": { + "description": "Optional. The private endpoint IP address for the Autonomous Database.", + "type": "string" + }, + "privateEndpointLabel": { + "description": "Optional. The private endpoint label for the Autonomous Database.", + "type": "string" + }, + "refreshableMode": { + "description": "Output only. The refresh mode of the cloned Autonomous Database.", + "enum": [ + "REFRESHABLE_MODE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "The default unspecified value.", + "AUTOMATIC indicates that the cloned database is automatically refreshed with data from the source Autonomous Database.", + "MANUAL indicates that the cloned database is manually refreshed with data from the source Autonomous Database." + ], + "readOnly": true, + "type": "string" + }, + "refreshableState": { + "description": "Output only. The refresh State of the clone.", + "enum": [ + "REFRESHABLE_STATE_UNSPECIFIED", + "REFRESHING", + "NOT_REFRESHING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Refreshing", + "Not refreshed" + ], + "readOnly": true, + "type": "string" + }, + "role": { + "description": "Output only. The Data Guard role of the Autonomous Database.", + "enum": [ + "ROLE_UNSPECIFIED", + "PRIMARY", + "STANDBY", + "DISABLED_STANDBY", + "BACKUP_COPY", + "SNAPSHOT_STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Primary role", + "Standby role", + "Disabled standby role", + "Backup copy role", + "Snapshot standby role" + ], + "readOnly": true, + "type": "string" + }, + "scheduledOperationDetails": { + "description": "Output only. The list and details of the scheduled operations of the Autonomous Database.", + "items": { + "$ref": "ScheduledOperationDetails" + }, + "readOnly": true, + "type": "array" + }, + "secretId": { + "description": "Optional. The ID of the Oracle Cloud Infrastructure vault secret.", + "type": "string" + }, + "sqlWebDeveloperUrl": { + "description": "Output only. The SQL Web Developer URL for the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], + "readOnly": true, + "type": "string" + }, + "supportedCloneRegions": { + "description": "Output only. The list of available regions that can be used to create a clone for the Autonomous Database.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "totalAutoBackupStorageSizeGbs": { + "description": "Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "usedDataStorageSizeTbs": { + "description": "Output only. The storage space used by Autonomous Database, in gigabytes.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "vaultId": { + "description": "Optional. The ID of the Oracle Cloud Infrastructure vault.", + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDatabaseStandbySummary": { + "description": "Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary", + "id": "AutonomousDatabaseStandbySummary", + "properties": { + "dataGuardRoleChangedTime": { + "description": "Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "disasterRecoveryRoleChangedTime": { + "description": "Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "lagTimeDuration": { + "description": "Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "lifecycleDetails": { + "description": "Output only. The additional details about the current lifecycle state of the Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Autonomous Database.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "UNAVAILABLE", + "RESTORE_IN_PROGRESS", + "RESTORE_FAILED", + "BACKUP_IN_PROGRESS", + "SCALE_IN_PROGRESS", + "AVAILABLE_NEEDS_ATTENTION", + "UPDATING", + "MAINTENANCE_IN_PROGRESS", + "RESTARTING", + "RECREATING", + "ROLE_CHANGE_IN_PROGRESS", + "UPGRADING", + "INACCESSIBLE", + "STANDBY" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the Autonomous Database is in provisioning state.", + "Indicates that the Autonomous Database is in available state.", + "Indicates that the Autonomous Database is in stopping state.", + "Indicates that the Autonomous Database is in stopped state.", + "Indicates that the Autonomous Database is in starting state.", + "Indicates that the Autonomous Database is in terminating state.", + "Indicates that the Autonomous Database is in terminated state.", + "Indicates that the Autonomous Database is in unavailable state.", + "Indicates that the Autonomous Database restore is in progress.", + "Indicates that the Autonomous Database failed to restore.", + "Indicates that the Autonomous Database backup is in progress.", + "Indicates that the Autonomous Database scale is in progress.", + "Indicates that the Autonomous Database is available but needs attention state.", + "Indicates that the Autonomous Database is in updating state.", + "Indicates that the Autonomous Database's maintenance is in progress state.", + "Indicates that the Autonomous Database is in restarting state.", + "Indicates that the Autonomous Database is in recreating state.", + "Indicates that the Autonomous Database's role change is in progress state.", + "Indicates that the Autonomous Database is in upgrading state.", + "Indicates that the Autonomous Database is in inaccessible state.", + "Indicates that the Autonomous Database is in standby state." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AutonomousDbVersion": { + "description": "Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/", + "id": "AutonomousDbVersion", + "properties": { + "dbWorkload": { + "description": "Output only. The Autonomous Database workload type.", + "enum": [ + "DB_WORKLOAD_UNSPECIFIED", + "OLTP", + "DW", + "AJD", + "APEX" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Autonomous Transaction Processing database.", + "Autonomous Data Warehouse database.", + "Autonomous JSON Database.", + "Autonomous Database with the Oracle APEX Application Development workload type." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Autonomous Database Version resource with the format: projects/{project}/locations/{region}/autonomousDbVersions/{autonomous_db_version}", + "type": "string" + }, + "version": { + "description": "Output only. An Oracle Database version for Autonomous Database.", + "readOnly": true, + "type": "string" + }, + "workloadUri": { + "description": "Output only. A URL that points to a detailed description of the Autonomous Database version.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudAccountDetails": { + "description": "Details of the OCI Cloud Account.", + "id": "CloudAccountDetails", + "properties": { + "accountCreationUri": { + "description": "Output only. URL to create a new account and link.", + "readOnly": true, + "type": "string" + }, + "cloudAccount": { + "description": "Output only. OCI account name.", + "readOnly": true, + "type": "string" + }, + "cloudAccountHomeRegion": { + "description": "Output only. OCI account home region.", + "readOnly": true, + "type": "string" + }, + "linkExistingAccountUri": { + "description": "Output only. URL to link an existing account.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CloudExadataInfrastructure": { + "description": "Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/", + "id": "CloudExadataInfrastructure", + "properties": { + "createTime": { + "description": "Output only. The date and time that the Exadata Infrastructure was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "entitlementId": { + "description": "Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned.", + "readOnly": true, + "type": "string" + }, + "gcpOracleZone": { + "description": "Optional. Google Cloud Platform location where Oracle Exadata is hosted.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels or tags associated with the resource.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project}/locations/{region}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}", + "type": "string" + }, + "properties": { + "$ref": "CloudExadataInfrastructureProperties", + "description": "Optional. Various properties of the infra." + } + }, + "type": "object" + }, + "CloudExadataInfrastructureProperties": { + "description": "Various properties of Exadata Infrastructure.", + "id": "CloudExadataInfrastructureProperties", + "properties": { + "activatedStorageCount": { + "description": "Output only. The requested number of additional storage servers activated for the Exadata Infrastructure.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "additionalStorageCount": { + "description": "Output only. The requested number of additional storage servers for the Exadata Infrastructure.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "availableStorageSizeGb": { + "description": "Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "computeCount": { + "description": "Optional. The number of compute servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "cpuCount": { + "description": "Optional. The number of enabled CPU cores.", + "format": "int32", + "type": "integer" + }, + "customerContacts": { + "description": "Optional. The list of customer contacts.", + "items": { + "$ref": "CustomerContact" + }, + "type": "array" + }, + "dataStorageSizeTb": { + "description": "Output only. Size, in terabytes, of the DATA disk group.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. The local node storage allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "dbServerVersion": { + "description": "Output only. The software version of the database servers (dom0) in the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "maintenanceWindow": { + "$ref": "MaintenanceWindow", + "description": "Optional. Maintenance window for repair." + }, + "maxCpuCount": { + "description": "Output only. The total number of CPU cores available.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "maxDataStorageTb": { + "description": "Output only. The total available DATA disk group size.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "maxDbNodeStorageSizeGb": { + "description": "Output only. The total local node storage available in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "maxMemoryGb": { + "description": "Output only. The total memory available in GBs.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "memorySizeGb": { + "description": "Optional. The memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "monthlyDbServerVersion": { + "description": "Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, + "type": "string" + }, + "monthlyStorageServerVersion": { + "description": "Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15", + "readOnly": true, + "type": "string" + }, + "nextMaintenanceRunId": { + "description": "Output only. The OCID of the next maintenance run.", + "readOnly": true, + "type": "string" + }, + "nextMaintenanceRunTime": { + "description": "Output only. The time when the next maintenance run will occur.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "nextSecurityMaintenanceRunTime": { + "description": "Output only. The time when the next security maintenance run will occur.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle", + "readOnly": true, + "type": "string" + }, + "shape": { + "description": "Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance.", + "type": "string" + }, + "state": { + "description": "Output only. The current lifecycle state of the Exadata Infrastructure.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "The Exadata Infrastructure is being provisioned.", + "The Exadata Infrastructure is available for use.", + "The Exadata Infrastructure is being updated.", + "The Exadata Infrastructure is being terminated.", + "The Exadata Infrastructure is terminated.", + "The Exadata Infrastructure is in failed state.", + "The Exadata Infrastructure is in maintenance." + ], + "readOnly": true, + "type": "string" + }, + "storageCount": { + "description": "Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure.", + "format": "int32", + "type": "integer" + }, + "storageServerVersion": { + "description": "Output only. The software version of the storage servers (cells) in the Exadata Infrastructure.", + "readOnly": true, + "type": "string" + }, + "totalStorageSizeGb": { + "description": "Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB).", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "CloudVmCluster": { + "description": "Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/", + "id": "CloudVmCluster", + "properties": { + "backupSubnetCidr": { + "description": "Required. CIDR range of the backup subnet.", + "type": "string" + }, + "cidr": { + "description": "Required. Network settings. CIDR to use for cluster IP allocation.", + "type": "string" + }, + "createTime": { + "description": "Output only. The date and time that the VM cluster was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "exadataInfrastructure": { + "description": "Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project}/locations/{region}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure}", + "type": "string" + }, + "gcpOracleZone": { + "description": "Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure.", + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels or tags associated with the VM Cluster.", + "type": "object" + }, + "name": { + "description": "Identifier. The name of the VM Cluster resource with the format: projects/{project}/locations/{region}/cloudVmClusters/{cloud_vm_cluster}", + "type": "string" + }, + "network": { + "description": "Required. The name of the VPC network. Format: projects/{project}/global/networks/{network}", + "type": "string" + }, + "properties": { + "$ref": "CloudVmClusterProperties", + "description": "Optional. Various properties of the VM Cluster." + } + }, + "type": "object" + }, + "CloudVmClusterProperties": { + "description": "Various properties and settings associated with Exadata VM cluster.", + "id": "CloudVmClusterProperties", + "properties": { + "clusterName": { + "description": "Optional. OCI Cluster name.", + "type": "string" + }, + "compartmentId": { + "description": "Output only. Compartment ID of cluster.", + "readOnly": true, + "type": "string" + }, + "cpuCoreCount": { + "description": "Required. Number of enabled CPU cores.", + "format": "int32", + "type": "integer" + }, + "dataStorageSizeTb": { + "description": "Optional. The data disk group size to be allocated in TBs.", + "format": "double", + "type": "number" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per VM.", + "format": "int32", + "type": "integer" + }, + "dbServerOcids": { + "description": "Optional. OCID of database servers.", + "items": { + "type": "string" + }, + "type": "array" + }, + "diagnosticsDataCollectionOptions": { + "$ref": "DataCollectionOptions", + "description": "Optional. Data collection options for diagnostics." + }, + "diskRedundancy": { + "description": "Optional. The type of redundancy.", + "enum": [ + "DISK_REDUNDANCY_UNSPECIFIED", + "HIGH", + "NORMAL" + ], + "enumDescriptions": [ + "Unspecified.", + "High - 3 way mirror.", + "Normal - 2 way mirror." + ], + "type": "string" + }, + "dnsListenerIp": { + "description": "Output only. DNS listener IP.", + "readOnly": true, + "type": "string" + }, + "domain": { + "description": "Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com", + "readOnly": true, + "type": "string" + }, + "giVersion": { + "description": "Optional. Grid Infrastructure Version.", + "type": "string" + }, + "hostname": { + "description": "Output only. host name without domain. format: \"-\" with some suffix. ex: sp2-yi0xq where \"sp2\" is the hostname_prefix.", + "readOnly": true, + "type": "string" + }, + "hostnamePrefix": { + "description": "Optional. Prefix for VM cluster host names.", + "type": "string" + }, + "licenseType": { + "description": "Required. License type of VM Cluster.", + "enum": [ + "LICENSE_TYPE_UNSPECIFIED", + "LICENSE_INCLUDED", + "BRING_YOUR_OWN_LICENSE" + ], + "enumDescriptions": [ + "Unspecified", + "License included part of offer", + "Bring your own license" + ], + "type": "string" + }, + "localBackupEnabled": { + "description": "Optional. Use local backup.", + "type": "boolean" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "nodeCount": { + "description": "Optional. Number of database servers.", + "format": "int32", + "type": "integer" + }, + "ociUrl": { + "description": "Output only. Deep link to the OCI console to view this resource.", + "readOnly": true, + "type": "string" + }, + "ocid": { + "description": "Output only. Oracle Cloud Infrastructure ID of VM Cluster.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per VM. Minimum is 0.1.", + "format": "float", + "type": "number" + }, + "scanDns": { + "description": "Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com", + "readOnly": true, + "type": "string" + }, + "scanDnsRecordId": { + "description": "Output only. OCID of scan DNS record.", + "readOnly": true, + "type": "string" + }, + "scanIpIds": { + "description": "Output only. OCIDs of scan IPs.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "scanListenerPortTcp": { + "description": "Output only. SCAN listener port - TCP", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "scanListenerPortTcpSsl": { + "description": "Output only. SCAN listener port - TLS", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "shape": { + "description": "Output only. Shape of VM Cluster.", + "readOnly": true, + "type": "string" + }, + "sparseDiskgroupEnabled": { + "description": "Optional. Use exadata sparse snapshots.", + "type": "boolean" + }, + "sshPublicKeys": { + "description": "Optional. SSH public keys to be stored with cluster.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "Output only. State of the cluster.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "TERMINATING", + "TERMINATED", + "FAILED", + "MAINTENANCE_IN_PROGRESS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state.", + "Indicates that the resource is in maintenance in progress state." + ], + "readOnly": true, + "type": "string" + }, + "storageSizeGb": { + "description": "Output only. The storage allocation for the disk group, in gigabytes (GB).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "systemVersion": { + "description": "Output only. Operating system version of the image.", + "readOnly": true, + "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified." + } + }, + "type": "object" + }, + "CustomerContact": { + "description": "The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact", + "id": "CustomerContact", + "properties": { + "email": { + "description": "Required. The email address used by Oracle to send notifications regarding databases and infrastructure.", + "type": "string" + } + }, + "type": "object" + }, + "DataCollectionOptions": { + "description": "Data collection options for diagnostics.", + "id": "DataCollectionOptions", + "properties": { + "diagnosticsEventsEnabled": { + "description": "Optional. Indicates whether diagnostic collection is enabled for the VM cluster", + "type": "boolean" + }, + "healthMonitoringEnabled": { + "description": "Optional. Indicates whether health monitoring is enabled for the VM cluster", + "type": "boolean" + }, + "incidentLogsEnabled": { + "description": "Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster", + "type": "boolean" + } + }, + "type": "object" + }, + "DatabaseConnectionStringProfile": { + "description": "The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile", + "id": "DatabaseConnectionStringProfile", + "properties": { + "consumerGroup": { + "description": "Output only. The current consumer group being used by the connection.", + "enum": [ + "CONSUMER_GROUP_UNSPECIFIED", + "HIGH", + "MEDIUM", + "LOW", + "TP", + "TPURGENT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "High consumer group.", + "Medium consumer group.", + "Low consumer group.", + "TP consumer group.", + "TPURGENT consumer group." + ], + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name for the database connection.", + "readOnly": true, + "type": "string" + }, + "hostFormat": { + "description": "Output only. The host name format being currently used in connection string.", + "enum": [ + "HOST_FORMAT_UNSPECIFIED", + "FQDN", + "IP" + ], + "enumDescriptions": [ + "Default unspecified value.", + "FQDN", + "IP" + ], + "readOnly": true, + "type": "string" + }, + "isRegional": { + "description": "Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard.", + "readOnly": true, + "type": "boolean" + }, + "protocol": { + "description": "Output only. The protocol being used by the connection.", + "enum": [ + "PROTOCOL_UNSPECIFIED", + "TCP", + "TCPS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Tcp", + "Tcps" + ], + "readOnly": true, + "type": "string" + }, + "sessionMode": { + "description": "Output only. The current session mode of the connection.", + "enum": [ + "SESSION_MODE_UNSPECIFIED", + "DIRECT", + "INDIRECT" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Direct", + "Indirect" + ], + "readOnly": true, + "type": "string" + }, + "syntaxFormat": { + "description": "Output only. The syntax of the connection string.", + "enum": [ + "SYNTAX_FORMAT_UNSPECIFIED", + "LONG", + "EZCONNECT", + "EZCONNECTPLUS" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Long", + "Ezconnect", + "Ezconnectplus" + ], + "readOnly": true, + "type": "string" + }, + "tlsAuthentication": { + "description": "Output only. This field indicates the TLS authentication type of the connection.", + "enum": [ + "TLS_AUTHENTICATION_UNSPECIFIED", + "SERVER", + "MUTUAL" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Server", + "Mutual" + ], + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Output only. The value of the connection string.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DbNode": { + "description": "Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/", + "id": "DbNode", + "properties": { + "name": { + "description": "Identifier. The name of the database node resource in the following format: projects/{project}/locations/{location}/cloudVmClusters/{cloud_vm_cluster}/dbNodes/{db_node}", + "type": "string" + }, + "properties": { + "$ref": "DbNodeProperties", + "description": "Optional. Various properties of the database node." + } + }, + "type": "object" + }, + "DbNodeProperties": { + "description": "Various properties and settings associated with Db node.", + "id": "DbNodeProperties", + "properties": { + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per database node.", + "format": "int32", + "type": "integer" + }, + "dbServerOcid": { + "description": "Optional. Database server OCID.", + "type": "string" + }, + "hostname": { + "description": "Optional. DNS", + "type": "string" + }, + "memorySizeGb": { + "description": "Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "ocid": { + "description": "Output only. OCID of database node.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per database node.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "Output only. State of the database node.", + "enum": [ + "STATE_UNSPECIFIED", + "PROVISIONING", + "AVAILABLE", + "UPDATING", + "STOPPING", + "STOPPED", + "STARTING", + "TERMINATING", + "TERMINATED", + "FAILED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in provisioning state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in updating state.", + "Indicates that the resource is in stopping state.", + "Indicates that the resource is in stopped state.", + "Indicates that the resource is in starting state.", + "Indicates that the resource is in terminating state.", + "Indicates that the resource is in terminated state.", + "Indicates that the resource is in failed state." + ], + "readOnly": true, + "type": "string" + }, + "totalCpuCoreCount": { + "description": "Total CPU core count of the database node.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DbServer": { + "description": "Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/", + "id": "DbServer", + "properties": { + "displayName": { + "description": "Optional. User friendly name for this resource.", + "type": "string" + }, + "name": { + "description": "Identifier. The name of the database server resource with the format: projects/{project}/locations/{location}/cloudExadataInfrastructures/{cloud_exadata_infrastructure}/dbServers/{db_server}", + "type": "string" + }, + "properties": { + "$ref": "DbServerProperties", + "description": "Optional. Various properties of the database server." + } + }, + "type": "object" + }, + "DbServerProperties": { + "description": "Various properties and settings associated with Exadata database server.", + "id": "DbServerProperties", + "properties": { + "dbNodeIds": { + "description": "Output only. OCID of database nodes associated with the database server.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "dbNodeStorageSizeGb": { + "description": "Optional. Local storage per VM.", + "format": "int32", + "type": "integer" + }, + "maxDbNodeStorageSizeGb": { + "description": "Optional. Maximum local storage per VM.", + "format": "int32", + "type": "integer" + }, + "maxMemorySizeGb": { + "description": "Optional. Maximum memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "maxOcpuCount": { + "description": "Optional. Maximum OCPU count per database.", + "format": "int32", + "type": "integer" + }, + "memorySizeGb": { + "description": "Optional. Memory allocated in GBs.", + "format": "int32", + "type": "integer" + }, + "ocid": { + "description": "Output only. OCID of database server.", + "readOnly": true, + "type": "string" + }, + "ocpuCount": { + "description": "Optional. OCPU count per database.", + "format": "int32", + "type": "integer" + }, + "state": { + "description": "Output only. State of the database server.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "AVAILABLE", + "UNAVAILABLE", + "DELETING", + "DELETED" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Indicates that the resource is in creating state.", + "Indicates that the resource is in available state.", + "Indicates that the resource is in unavailable state.", + "Indicates that the resource is in deleting state.", + "Indicates that the resource is in deleted state." + ], + "readOnly": true, + "type": "string" + }, + "vmCount": { + "description": "Optional. Vm count per database.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "DbSystemShape": { + "description": "Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/", + "id": "DbSystemShape", + "properties": { + "availableCoreCountPerNode": { + "description": "Optional. Number of cores per node.", + "format": "int32", + "type": "integer" + }, + "availableDataStorageTb": { + "description": "Optional. Storage per storage server in terabytes.", + "format": "int32", + "type": "integer" + }, + "availableMemoryPerNodeGb": { + "description": "Optional. Memory per database server node in gigabytes.", + "format": "int32", + "type": "integer" + }, + "maxNodeCount": { + "description": "Optional. Maximum number of database servers.", + "format": "int32", + "type": "integer" + }, + "maxStorageCount": { + "description": "Optional. Maximum number of storage servers.", + "format": "int32", + "type": "integer" + }, + "minCoreCountPerNode": { + "description": "Optional. Minimum core count per node.", + "format": "int32", + "type": "integer" + }, + "minDbNodeStoragePerNodeGb": { + "description": "Optional. Minimum node storage per database server in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minMemoryPerNodeGb": { + "description": "Optional. Minimum memory per node in gigabytes.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Optional. Minimum number of database servers.", + "format": "int32", + "type": "integer" + }, + "minStorageCount": { + "description": "Optional. Minimum number of storage servers.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Identifier. The name of the Database System Shape resource with the format: projects/{project}/locations/{region}/dbSystemShapes/{db_system_shape}", + "type": "string" + }, + "shape": { + "description": "Optional. shape", + "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" + }, + "Entitlement": { + "description": "Details of the Entitlement resource.", + "id": "Entitlement", + "properties": { + "cloudAccountDetails": { + "$ref": "CloudAccountDetails", + "description": "Details of the OCI Cloud Account." + }, + "entitlementId": { + "description": "Output only. Google Cloud Marketplace order ID (aka entitlement ID)", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The name of the Entitlement resource with the format: projects/{project}/locations/{region}/entitlements/{entitlement}", + "type": "string" + }, + "state": { + "description": "Output only. Entitlement State.", + "enum": [ + "STATE_UNSPECIFIED", + "ACCOUNT_NOT_LINKED", + "ACCOUNT_NOT_ACTIVE", + "ACTIVE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Account not linked.", + "Account is linked but not active.", + "Entitlement and Account are active." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GenerateAutonomousDatabaseWalletRequest": { + "description": "The request for `AutonomousDatabase.GenerateWallet`.", + "id": "GenerateAutonomousDatabaseWalletRequest", + "properties": { + "isRegional": { + "description": "Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only.", + "type": "boolean" + }, + "password": { + "description": "Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters.", + "type": "string" + }, + "type": { + "description": "Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE.", + "enum": [ + "GENERATE_TYPE_UNSPECIFIED", + "ALL", + "SINGLE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Used to generate wallet for all databases in the region.", + "Used to generate wallet for a single database." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenerateAutonomousDatabaseWalletResponse": { + "description": "The response for `AutonomousDatabase.GenerateWallet`.", + "id": "GenerateAutonomousDatabaseWalletResponse", + "properties": { + "archiveContent": { + "description": "Output only. The base64 encoded wallet files.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GiVersion": { + "description": "Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/", + "id": "GiVersion", + "properties": { + "name": { + "description": "Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project}/locations/{region}/giVersions/{gi_versions}", + "type": "string" + }, + "version": { + "description": "Optional. version", + "type": "string" + } + }, + "type": "object" + }, + "ListAutonomousDatabaseBackupsResponse": { + "description": "The response for `AutonomousDatabaseBackup.List`.", + "id": "ListAutonomousDatabaseBackupsResponse", + "properties": { + "autonomousDatabaseBackups": { + "description": "The list of Autonomous Database Backups.", + "items": { + "$ref": "AutonomousDatabaseBackup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAutonomousDatabaseCharacterSetsResponse": { + "description": "The response for `AutonomousDatabaseCharacterSet.List`.", + "id": "ListAutonomousDatabaseCharacterSetsResponse", + "properties": { + "autonomousDatabaseCharacterSets": { + "description": "The list of Autonomous Database Character Sets.", + "items": { + "$ref": "AutonomousDatabaseCharacterSet" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAutonomousDatabasesResponse": { + "description": "The response for `AutonomousDatabase.List`.", + "id": "ListAutonomousDatabasesResponse", + "properties": { + "autonomousDatabases": { + "description": "The list of Autonomous Databases.", + "items": { + "$ref": "AutonomousDatabase" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAutonomousDbVersionsResponse": { + "description": "The response for `AutonomousDbVersion.List`.", + "id": "ListAutonomousDbVersionsResponse", + "properties": { + "autonomousDbVersions": { + "description": "The list of Autonomous Database versions.", + "items": { + "$ref": "AutonomousDbVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListCloudExadataInfrastructuresResponse": { + "description": "The response for `CloudExadataInfrastructures.list`.", + "id": "ListCloudExadataInfrastructuresResponse", + "properties": { + "cloudExadataInfrastructures": { + "description": "The list of Exadata Infrastructures.", + "items": { + "$ref": "CloudExadataInfrastructure" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token for fetching next page of response.", + "type": "string" + } + }, + "type": "object" + }, + "ListCloudVmClustersResponse": { + "description": "The response for `CloudVmCluster.List`.", + "id": "ListCloudVmClustersResponse", + "properties": { + "cloudVmClusters": { + "description": "The list of VM Clusters.", + "items": { + "$ref": "CloudVmCluster" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to fetch the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListDbNodesResponse": { + "description": "The response for `DbNode.List`.", + "id": "ListDbNodesResponse", + "properties": { + "dbNodes": { + "description": "The list of DB Nodes", + "items": { + "$ref": "DbNode" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the node should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListDbServersResponse": { + "description": "The response for `DbServer.List`.", + "id": "ListDbServersResponse", + "properties": { + "dbServers": { + "description": "The list of database servers.", + "items": { + "$ref": "DbServer" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListDbSystemShapesResponse": { + "description": "The response for `DbSystemShape.List`.", + "id": "ListDbSystemShapesResponse", + "properties": { + "dbSystemShapes": { + "description": "The list of Database System shapes.", + "items": { + "$ref": "DbSystemShape" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListEntitlementsResponse": { + "description": "The response for `Entitlement.List`.", + "id": "ListEntitlementsResponse", + "properties": { + "entitlements": { + "description": "The list of Entitlements", + "items": { + "$ref": "Entitlement" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListGiVersionsResponse": { + "description": "The response for `GiVersion.List`.", + "id": "ListGiVersionsResponse", + "properties": { + "giVersions": { + "description": "The list of Oracle Grid Infrastructure (GI) versions.", + "items": { + "$ref": "GiVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + } + }, + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "id": "ListLocationsResponse", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "items": { + "$ref": "Location" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "items": { + "$ref": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud location.", + "id": "Location", + "properties": { + "displayName": { + "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "type": "object" + }, + "LocationMetadata": { + "description": "Metadata for a given Location.", + "id": "LocationMetadata", + "properties": { + "gcpOracleZones": { + "description": "Output only. Google Cloud Platform Oracle zones in a location.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow", + "id": "MaintenanceWindow", + "properties": { + "customActionTimeoutMins": { + "description": "Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive).", + "format": "int32", + "type": "integer" + }, + "daysOfWeek": { + "description": "Optional. Days during the week when maintenance should be performed.", + "items": { + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "type": "array" + }, + "hoursOfDay": { + "description": "Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "isCustomActionTimeoutEnabled": { + "description": "Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations.", + "type": "boolean" + }, + "leadTimeWeek": { + "description": "Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4.", + "format": "int32", + "type": "integer" + }, + "months": { + "description": "Optional. Months during the year when maintenance should be performed.", + "items": { + "enum": [ + "MONTH_UNSPECIFIED", + "JANUARY", + "FEBRUARY", + "MARCH", + "APRIL", + "MAY", + "JUNE", + "JULY", + "AUGUST", + "SEPTEMBER", + "OCTOBER", + "NOVEMBER", + "DECEMBER" + ], + "enumDescriptions": [ + "The unspecified month.", + "The month of January.", + "The month of February.", + "The month of March.", + "The month of April.", + "The month of May.", + "The month of June.", + "The month of July.", + "The month of August.", + "The month of September.", + "The month of October.", + "The month of November.", + "The month of December." + ], + "type": "string" + }, + "type": "array" + }, + "patchingMode": { + "description": "Optional. Cloud CloudExadataInfrastructure node patching method, either \"ROLLING\" or \"NONROLLING\". Default value is ROLLING.", + "enum": [ + "PATCHING_MODE_UNSPECIFIED", + "ROLLING", + "NON_ROLLING" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Updates the Cloud Exadata database server hosts in a rolling fashion.", + "The non-rolling maintenance method first updates your storage servers at the same time, then your database servers at the same time." + ], + "type": "string" + }, + "preference": { + "description": "Optional. The maintenance window scheduling preference.", + "enum": [ + "MAINTENANCE_WINDOW_PREFERENCE_UNSPECIFIED", + "CUSTOM_PREFERENCE", + "NO_PREFERENCE" + ], + "enumDescriptions": [ + "Default unspecified value.", + "Custom preference.", + "No preference." + ], + "type": "string" + }, + "weeksOfMonth": { + "description": "Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "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" + }, + "percentComplete": { + "description": "Output only. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "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. The status of the operation.", + "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" + }, + "RestoreAutonomousDatabaseRequest": { + "description": "The request for `AutonomousDatabase.Restore`.", + "id": "RestoreAutonomousDatabaseRequest", + "properties": { + "restoreTime": { + "description": "Required. The time and date to restore the database to.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "ScheduledOperationDetails": { + "description": "Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails", + "id": "ScheduledOperationDetails", + "properties": { + "dayOfWeek": { + "description": "Output only. Day of week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "readOnly": true, + "type": "string" + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Output only. Auto start time.", + "readOnly": true + }, + "stopTime": { + "$ref": "TimeOfDay", + "description": "Output only. Auto stop time.", + "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", + "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" + }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Oracle Database@Google Cloud API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/osconfig-v1.json b/discovery/osconfig-v1.json index 133774e6f7..d801c162cb 100644 --- a/discovery/osconfig-v1.json +++ b/discovery/osconfig-v1.json @@ -1083,7 +1083,7 @@ } } }, - "revision": "20240901", + "revision": "20241002", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { @@ -3500,22 +3500,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/osconfig-v1alpha.json b/discovery/osconfig-v1alpha.json index 9ff5496e03..3e45373514 100644 --- a/discovery/osconfig-v1alpha.json +++ b/discovery/osconfig-v1alpha.json @@ -707,7 +707,7 @@ } } }, - "revision": "20240602", + "revision": "20240901", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { @@ -1141,7 +1141,7 @@ "AVAILABLE_PACKAGE" ], "enumDescriptions": [ - "Invalid. An type must be specified.", + "Invalid. A type must be specified.", "This represents a package that is installed on the VM.", "This represents an update that is available for a package." ], diff --git a/discovery/osconfig-v1beta.json b/discovery/osconfig-v1beta.json index 47e0d40158..83d5898782 100644 --- a/discovery/osconfig-v1beta.json +++ b/discovery/osconfig-v1beta.json @@ -689,7 +689,7 @@ } } }, - "revision": "20220319", + "revision": "20241002", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { @@ -2268,22 +2268,22 @@ "id": "TimeOfDay", "properties": { "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", "format": "int32", "type": "integer" }, "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", + "description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", "format": "int32", "type": "integer" }, "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", "format": "int32", "type": "integer" }, "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", "format": "int32", "type": "integer" } diff --git a/discovery/paymentsresellersubscription-v1.json b/discovery/paymentsresellersubscription-v1.json index 73e1321256..b9f17ad94e 100644 --- a/discovery/paymentsresellersubscription-v1.json +++ b/discovery/paymentsresellersubscription-v1.json @@ -435,7 +435,7 @@ } } }, - "revision": "20240626", + "revision": "20240922", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { @@ -478,7 +478,7 @@ "CANCELLATION_REASON_OTHER" ], "enumDescriptions": [ - "Reason is unspecified.", + "Reason is unspecified. Should not be used.", "Fraudualant transaction.", "Buyer's remorse.", "Accidential purchase.", @@ -1182,7 +1182,7 @@ "CANCELLATION_REASON_OTHER" ], "enumDescriptions": [ - "Reason is unspecified.", + "Reason is unspecified. Should not be used.", "Fraudualant transaction.", "Buyer's remorse.", "Accidential purchase.", diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 55a77eddbd..7125be4e2f 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -14,6 +14,9 @@ "https://www.googleapis.com/auth/maps-platform.places.details": { "description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.details" }, + "https://www.googleapis.com/auth/maps-platform.places.getphotomedia": { + "description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.getphotomedia" + }, "https://www.googleapis.com/auth/maps-platform.places.nearbysearch": { "description": "Private Service: https://www.googleapis.com/auth/maps-platform.places.nearbysearch" }, @@ -268,7 +271,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/maps-platform.places" + "https://www.googleapis.com/auth/maps-platform.places", + "https://www.googleapis.com/auth/maps-platform.places.getphotomedia" ] } } @@ -276,7 +280,7 @@ } } }, - "revision": "20240825", + "revision": "20240920", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1494,6 +1498,17 @@ }, "type": "object" }, + "GoogleMapsPlacesV1Polyline": { + "description": "A route polyline. Only supports an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), which can be passed as a string and includes compression with minimal lossiness. This is the Routes API default output.", + "id": "GoogleMapsPlacesV1Polyline", + "properties": { + "encodedPolyline": { + "description": "An [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), as returned by the [Routes API by default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). See the [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) and [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) tools.", + "type": "string" + } + }, + "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", @@ -1552,6 +1567,109 @@ }, "type": "object" }, + "GoogleMapsPlacesV1RouteModifiers": { + "description": "Encapsulates a set of optional conditions to satisfy when calculating the routes.", + "id": "GoogleMapsPlacesV1RouteModifiers", + "properties": { + "avoidFerries": { + "description": "Optional. When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`.", + "type": "boolean" + }, + "avoidHighways": { + "description": "Optional. When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`.", + "type": "boolean" + }, + "avoidIndoor": { + "description": "Optional. When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the `WALK` `TravelMode`.", + "type": "boolean" + }, + "avoidTolls": { + "description": "Optional. When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1RoutingParameters": { + "description": "Parameters to configure the routing calculations to the places in the response, both along a route (where result ranking will be influenced) and for calculating travel times on results.", + "id": "GoogleMapsPlacesV1RoutingParameters", + "properties": { + "origin": { + "$ref": "GoogleTypeLatLng", + "description": "Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used." + }, + "routeModifiers": { + "$ref": "GoogleMapsPlacesV1RouteModifiers", + "description": "Optional. The route modifiers." + }, + "routingPreference": { + "description": "Optional. Specifies how to compute the routing summaries. The server attempts to use the selected routing preference to compute the route. The traffic aware routing preference is only available for the `DRIVE` or `TWO_WHEELER` `travelMode`.", + "enum": [ + "ROUTING_PREFERENCE_UNSPECIFIED", + "TRAFFIC_UNAWARE", + "TRAFFIC_AWARE", + "TRAFFIC_AWARE_OPTIMAL" + ], + "enumDescriptions": [ + "No routing preference specified. Default to `TRAFFIC_UNAWARE`.", + "Computes routes without taking live traffic conditions into consideration. Suitable when traffic conditions don't matter or are not applicable. Using this value produces the lowest latency. Note: For `TravelMode` `DRIVE` and `TWO_WHEELER`, the route and duration chosen are based on road network and average time-independent traffic conditions, not current road conditions. Consequently, routes may include roads that are temporarily closed. Results for a given request may vary over time due to changes in the road network, updated average traffic conditions, and the distributed nature of the service. Results may also vary between nearly-equivalent routes at any time or frequency.", + "Calculates routes taking live traffic conditions into consideration. In contrast to `TRAFFIC_AWARE_OPTIMAL`, some optimizations are applied to significantly reduce latency.", + "Calculates the routes taking live traffic conditions into consideration, without applying most performance optimizations. Using this value produces the highest latency." + ], + "type": "string" + }, + "travelMode": { + "description": "Optional. The travel mode.", + "enum": [ + "TRAVEL_MODE_UNSPECIFIED", + "DRIVE", + "BICYCLE", + "WALK", + "TWO_WHEELER" + ], + "enumDescriptions": [ + "No travel mode specified. Defaults to `DRIVE`.", + "Travel by passenger car.", + "Travel by bicycle. Not supported with `search_along_route_parameters`.", + "Travel by walking. Not supported with `search_along_route_parameters`.", + "Motorized two wheeled vehicles of all kinds such as scooters and motorcycles. Note that this is distinct from the `BICYCLE` travel mode which covers human-powered transport. Not supported with `search_along_route_parameters`. Only supported in those countries listed at [Countries and regions supported for two-wheeled vehicles](https://developers.google.com/maps/documentation/routes/coverage-two-wheeled)." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1RoutingSummary": { + "description": "The duration and distance from the routing origin to a place in the response, and a second leg from that place to the destination, if requested. **Note:** Adding `routingSummaries` in the field mask without also including either the `routingParameters.origin` parameter or the `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the request causes an error.", + "id": "GoogleMapsPlacesV1RoutingSummary", + "properties": { + "legs": { + "description": "The legs of the trip. When you calculate travel duration and distance from a set origin, `legs` contains a single leg containing the duration and distance from the origin to the destination. When you do a search along route, `legs` contains two legs: one from the origin to place, and one from the place to the destination.", + "items": { + "$ref": "GoogleMapsPlacesV1RoutingSummaryLeg" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1RoutingSummaryLeg": { + "description": "A leg is a single portion of a journey from one location to another.", + "id": "GoogleMapsPlacesV1RoutingSummaryLeg", + "properties": { + "distanceMeters": { + "description": "The distance of this leg of the trip.", + "format": "int32", + "type": "integer" + }, + "duration": { + "description": "The time it takes to complete this leg of the trip.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GoogleMapsPlacesV1SearchNearbyRequest": { "description": "Request proto for Search Nearby. ", "id": "GoogleMapsPlacesV1SearchNearbyRequest", @@ -1614,6 +1732,10 @@ "regionCode": { "description": "The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported.", "type": "string" + }, + "routingParameters": { + "$ref": "GoogleMapsPlacesV1RoutingParameters", + "description": "Optional. Parameters that affect the routing to the search results." } }, "type": "object" @@ -1639,6 +1761,13 @@ "$ref": "GoogleMapsPlacesV1Place" }, "type": "array" + }, + "routingSummaries": { + "description": "A list of routing summaries where each entry associates to the corresponding place in the same index in the `places` field. If the routing summary is not available for one of the places, it will contain an empty entry. This list should have as many entries as the list of places if requested.", + "items": { + "$ref": "GoogleMapsPlacesV1RoutingSummary" + }, + "type": "array" } }, "type": "object" @@ -1732,6 +1861,14 @@ "description": "The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported.", "type": "string" }, + "routingParameters": { + "$ref": "GoogleMapsPlacesV1RoutingParameters", + "description": "Optional. Additional parameters for routing to results." + }, + "searchAlongRouteParameters": { + "$ref": "GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters", + "description": "Optional. Additional parameters proto for searching along a route." + }, "strictTypeFiltering": { "description": "Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.", "type": "boolean" @@ -1812,6 +1949,17 @@ }, "type": "object" }, + "GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters": { + "description": "Specifies a precalculated polyline from the [Routes API](https://developers.google.com/maps/documentation/routes) defining the route to search. Searching along a route is similar to using the `locationBias` or `locationRestriction` request option to bias the search results. However, while the `locationBias` and `locationRestriction` options let you specify a region to bias the search results, this option lets you bias the results along a trip route. Results are not guaranteed to be along the route provided, but rather are ranked within the search area defined by the polyline and, optionally, by the `locationBias` or `locationRestriction` based on minimal detour times from origin to destination. The results might be along an alternate route, especially if the provided polyline does not define an optimal route from origin to destination.", + "id": "GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters", + "properties": { + "polyline": { + "$ref": "GoogleMapsPlacesV1Polyline", + "description": "Required. The route polyline." + } + }, + "type": "object" + }, "GoogleMapsPlacesV1SearchTextResponse": { "description": "Response proto for SearchText. ", "id": "GoogleMapsPlacesV1SearchTextResponse", @@ -1833,6 +1981,13 @@ "$ref": "GoogleMapsPlacesV1Place" }, "type": "array" + }, + "routingSummaries": { + "description": "A list of routing summaries where each entry associates to the corresponding place in the same index in the `places` field. If the routing summary is not available for one of the places, it will contain an empty entry. This list will have as many entries as the list of places if requested.", + "items": { + "$ref": "GoogleMapsPlacesV1RoutingSummary" + }, + "type": "array" } }, "type": "object" diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index 02551dae2e..245060182c 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -565,7 +565,7 @@ ], "parameters": { "filter": { - "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", + "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", "location": "query", "type": "string" }, @@ -947,7 +947,7 @@ } } }, - "revision": "20240704", + "revision": "20240926", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1197,12 +1197,14 @@ "enum": [ "ERROR_TYPE_UNSPECIFIED", "APPLICATION_NOT_RESPONDING", - "CRASH" + "CRASH", + "NON_FATAL" ], "enumDescriptions": [ "Unspecified error type.", "Application Not Responding (ANR) error. To learn more about this type of errors visit the corresponding Android Developers documentation.", - "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV." + "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV.", + "Non-fatal caused by events that do not immediately cause crashes, but is likely to lead to one." ], "type": "string" } @@ -1247,12 +1249,14 @@ "enum": [ "ERROR_TYPE_UNSPECIFIED", "APPLICATION_NOT_RESPONDING", - "CRASH" + "CRASH", + "NON_FATAL" ], "enumDescriptions": [ "Unspecified error type.", "Application Not Responding (ANR) error. To learn more about this type of errors visit the corresponding Android Developers documentation.", - "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV." + "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV.", + "Non-fatal caused by events that do not immediately cause crashes, but is likely to lead to one." ], "type": "string" }, diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index cbfcbec6a0..0879eb1b3c 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -565,7 +565,7 @@ ], "parameters": { "filter": { - "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", + "description": "A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = \"google/walleye\" OR deviceModel = \"google/marlin\"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = \"Google\". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = \"PHONE\"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)`", "location": "query", "type": "string" }, @@ -947,7 +947,7 @@ } } }, - "revision": "20240704", + "revision": "20240926", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1197,12 +1197,14 @@ "enum": [ "ERROR_TYPE_UNSPECIFIED", "APPLICATION_NOT_RESPONDING", - "CRASH" + "CRASH", + "NON_FATAL" ], "enumDescriptions": [ "Unspecified error type.", "Application Not Responding (ANR) error. To learn more about this type of errors visit the corresponding Android Developers documentation.", - "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV." + "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV.", + "Non-fatal caused by events that do not immediately cause crashes, but is likely to lead to one." ], "type": "string" } @@ -1247,12 +1249,14 @@ "enum": [ "ERROR_TYPE_UNSPECIFIED", "APPLICATION_NOT_RESPONDING", - "CRASH" + "CRASH", + "NON_FATAL" ], "enumDescriptions": [ "Unspecified error type.", "Application Not Responding (ANR) error. To learn more about this type of errors visit the corresponding Android Developers documentation.", - "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV." + "Crash caused by an unhandled exception in Java (or Kotlin or any other JVM language) or a signal in native code such as SIGSEGV.", + "Non-fatal caused by events that do not immediately cause crashes, but is likely to lead to one." ], "type": "string" }, diff --git a/discovery/privateca-v1.json b/discovery/privateca-v1.json index 5840a4e951..56bdaf3238 100644 --- a/discovery/privateca-v1.json +++ b/discovery/privateca-v1.json @@ -392,7 +392,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.", + "description": "Output only. Identifier. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/caPools/[^/]+$", "required": true, @@ -1605,7 +1605,7 @@ } } }, - "revision": "20240819", + "revision": "20240918", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { @@ -1762,7 +1762,7 @@ "type": "object" }, "name": { - "description": "Output only. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.", + "description": "Output only. Identifier. The resource name for this CaPool in the format `projects/*/locations/*/caPools/*`.", "readOnly": true, "type": "string" }, diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 0780fc1a7f..f45f2a8fd2 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -1638,7 +1638,7 @@ } } }, - "revision": "20240730", + "revision": "20240918", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1685,6 +1685,12 @@ }, "type": "object" }, + "AvroFormat": { + "description": "Configuration for reading Cloud Storage data in Avro binary format. The bytes of each object will be set to the `data` field of a Pub/Sub message.", + "id": "AvroFormat", + "properties": {}, + "type": "object" + }, "AwsKinesis": { "description": "Ingestion settings for Amazon Kinesis Data Streams.", "id": "AwsKinesis", @@ -1803,6 +1809,59 @@ }, "type": "object" }, + "CloudStorage": { + "description": "Ingestion settings for Cloud Storage.", + "id": "CloudStorage", + "properties": { + "avroFormat": { + "$ref": "AvroFormat", + "description": "Optional. Data from Cloud Storage will be interpreted in Avro format." + }, + "bucket": { + "description": "Optional. Cloud Storage bucket. The bucket name must be without any prefix like \"gs://\". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming).", + "type": "string" + }, + "matchGlob": { + "description": "Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the [supported patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).", + "type": "string" + }, + "minimumObjectCreateTime": { + "description": "Optional. Only objects with a larger or equal creation timestamp will be ingested.", + "format": "google-datetime", + "type": "string" + }, + "pubsubAvroFormat": { + "$ref": "PubSubAvroFormat", + "description": "Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage)." + }, + "state": { + "description": "Output only. An output-only field that indicates the state of the Cloud Storage ingestion source.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CLOUD_STORAGE_PERMISSION_DENIED", + "PUBLISH_PERMISSION_DENIED", + "BUCKET_NOT_FOUND", + "TOO_MANY_OBJECTS" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Ingestion is active.", + "Permission denied encountered while calling the Cloud Storage API. This can happen if the Pub/Sub SA has not been granted the [appropriate permissions](https://cloud.google.com/storage/docs/access-control/iam-permissions): - storage.objects.list: to list the objects in a bucket. - storage.objects.get: to read the objects in a bucket. - storage.buckets.get: to verify the bucket exists.", + "Permission denied encountered while publishing to the topic. This can happen if the Pub/Sub SA has not been granted the [appropriate publish permissions](https://cloud.google.com/pubsub/docs/access-control#pubsub.publisher)", + "The provided Cloud Storage bucket doesn't exist.", + "The Cloud Storage bucket has too many objects, ingestion will be paused." + ], + "readOnly": true, + "type": "string" + }, + "textFormat": { + "$ref": "TextFormat", + "description": "Optional. Data from Cloud Storage will be interpreted as text." + } + }, + "type": "object" + }, "CloudStorageConfig": { "description": "Configuration for a Cloud Storage subscription.", "id": "CloudStorageConfig", @@ -1973,6 +2032,14 @@ "awsKinesis": { "$ref": "AwsKinesis", "description": "Optional. Amazon Kinesis Data Streams." + }, + "cloudStorage": { + "$ref": "CloudStorage", + "description": "Optional. Cloud Storage." + }, + "platformLogsSettings": { + "$ref": "PlatformLogsSettings", + "description": "Optional. Platform Logs settings. If unset, no Platform Logs will be generated." } }, "type": "object" @@ -2177,6 +2244,33 @@ }, "type": "object" }, + "PlatformLogsSettings": { + "description": "Settings for Platform Logs produced by Pub/Sub.", + "id": "PlatformLogsSettings", + "properties": { + "severity": { + "description": "Optional. The minimum severity level of Platform Logs that will be written.", + "enum": [ + "SEVERITY_UNSPECIFIED", + "DISABLED", + "DEBUG", + "INFO", + "WARNING", + "ERROR" + ], + "enumDescriptions": [ + "Default value. Logs level is unspecified. Logs will be disabled.", + "Logs will be disabled.", + "Debug logs and higher-severity logs will be written.", + "Info logs and higher-severity logs will be written.", + "Warning logs and higher-severity logs will be written.", + "Only error logs will be written." + ], + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -2201,6 +2295,12 @@ }, "type": "object" }, + "PubSubAvroFormat": { + "description": "Configuration for reading Cloud Storage data written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing.", + "id": "PubSubAvroFormat", + "properties": {}, + "type": "object" + }, "PublishRequest": { "description": "Request for the Publish method.", "id": "PublishRequest", @@ -2563,7 +2663,7 @@ "type": "object" }, "messageRetentionDuration": { - "description": "Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes.", + "description": "Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes.", "format": "google-duration", "type": "string" }, @@ -2645,6 +2745,17 @@ "properties": {}, "type": "object" }, + "TextFormat": { + "description": "Configuration for reading Cloud Storage data in text format. Each line of text as specified by the delimiter will be set to the `data` field of a Pub/Sub message.", + "id": "TextFormat", + "properties": { + "delimiter": { + "description": "Optional. When unset, '\\n' is used.", + "type": "string" + } + }, + "type": "object" + }, "Topic": { "description": "A topic resource.", "id": "Topic", diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json index 98a8a73508..1a002af675 100644 --- a/discovery/realtimebidding-v1.json +++ b/discovery/realtimebidding-v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20240806", + "revision": "20240930", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -3251,11 +3251,11 @@ "readOnly": true }, "videoUrl": { - "description": "The URL to fetch a video ad.", + "description": "The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0, 3.0 or 4.x standard.", "type": "string" }, "videoVastXml": { - "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.", + "description": "The contents of a VAST document for a video ad. This document should conform to the VAST 2.0, 3.0, or 4.x standard.", "type": "string" } }, diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 63d2c8d0aa..653ca4d620 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -147,7 +147,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the project in which the assessment will be created, in the format `projects/{project}`.", + "description": "Required. The name of the project in which the assessment is created, in the format `projects/{project}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -179,7 +179,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the project this policy will apply to, in the format `projects/{project}`.", + "description": "Required. The name of the project this policy applies to, in the format `projects/{project}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -300,7 +300,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated.", + "description": "Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -350,7 +350,7 @@ "keys": { "methods": { "addIpOverride": { - "description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.", + "description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.", "flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride", "httpMethod": "POST", "id": "recaptchaenterprise.projects.keys.addIpOverride", @@ -387,7 +387,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the project in which the key will be created, in the format `projects/{project}`.", + "description": "Required. The name of the project in which the key is created, in the format `projects/{project}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -501,7 +501,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the project that contains the keys that will be listed, in the format `projects/{project}`.", + "description": "Required. The name of the project that contains the keys that is listed, in the format `projects/{project}`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -597,7 +597,7 @@ "type": "string" }, "updateMask": { - "description": "Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.", + "description": "Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -615,7 +615,7 @@ ] }, "removeIpOverride": { - "description": "Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned.", + "description": "Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned.", "flatPath": "v1/projects/{projectsId}/keys/{keysId}:removeIpOverride", "httpMethod": "POST", "id": "recaptchaenterprise.projects.keys.removeIpOverride", @@ -786,7 +786,7 @@ } } }, - "revision": "20240825", + "revision": "20240906", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -918,7 +918,7 @@ "type": "string" }, "annotation": { - "description": "Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.", + "description": "Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.", "enum": [ "ANNOTATION_UNSPECIFIED", "LEGITIMATE", @@ -1164,7 +1164,7 @@ "type": "boolean" }, "firewallPolicyEvaluation": { - "description": "Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.", + "description": "Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response.", "type": "boolean" }, "fraudPrevention": { @@ -1249,23 +1249,23 @@ }, "block": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction", - "description": "This action will deny access to a given page. The user will get an HTTP error code." + "description": "This action denies access to a given page. The user gets an HTTP error code." }, "includeRecaptchaScript": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction", - "description": "This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend." + "description": "This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend." }, "redirect": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction", - "description": "This action will redirect the request to a ReCaptcha interstitial to attach a token." + "description": "This action redirects the request to a reCAPTCHA interstitial to attach a token." }, "setHeader": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction", - "description": "This action will set a custom header but allow the request to continue to the customer backend." + "description": "This action sets a custom header but allow the request to continue to the customer backend." }, "substitute": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction", - "description": "This action will transparently serve a different page to an offending user." + "description": "This action transparently serves a different page to an offending user." } }, "type": "object" @@ -1289,7 +1289,7 @@ "type": "object" }, "GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction": { - "description": "A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token.", + "description": "A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token.", "id": "GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction", "properties": {}, "type": "object" @@ -1356,12 +1356,12 @@ "properties": { "error": { "$ref": "GoogleRpcStatus", - "description": "Output only. If the processing of a policy config fails, an error will be populated and the firewall_policy will be left empty.", + "description": "Output only. If the processing of a policy config fails, an error is populated and the firewall_policy is left empty.", "readOnly": true }, "firewallPolicy": { "$ref": "GoogleCloudRecaptchaenterpriseV1FirewallPolicy", - "description": "Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the incoming request, the policy field will be left empty.", + "description": "Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the incoming request, the policy field is left empty.", "readOnly": true } }, @@ -1514,7 +1514,7 @@ }, "appleDeveloperId": { "$ref": "GoogleCloudRecaptchaenterpriseV1AppleDeveloperId", - "description": "Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app." + "description": "Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app." } }, "type": "object" @@ -1689,7 +1689,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1Metrics", "properties": { "challengeMetrics": { - "description": "Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.", + "description": "Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.", "items": { "$ref": "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics" }, @@ -1701,7 +1701,7 @@ "type": "string" }, "scoreMetrics": { - "description": "Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.", + "description": "Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.", "items": { "$ref": "GoogleCloudRecaptchaenterpriseV1ScoreMetrics" }, @@ -2010,7 +2010,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1TestingOptions", "properties": { "testingChallenge": { - "description": "Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.", + "description": "Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.", "enum": [ "TESTING_CHALLENGE_UNSPECIFIED", "NOCAPTCHA", @@ -2024,7 +2024,7 @@ "type": "string" }, "testingScore": { - "description": "Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.", + "description": "Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.", "format": "float", "type": "number" } @@ -2410,13 +2410,15 @@ "WAF_SERVICE_UNSPECIFIED", "CA", "FASTLY", - "CLOUDFLARE" + "CLOUDFLARE", + "AKAMAI" ], "enumDescriptions": [ "Undefined WAF", "Cloud Armor", "Fastly", - "Cloudflare" + "Cloudflare", + "Akamai" ], "type": "string" } @@ -2428,7 +2430,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1WebKeySettings", "properties": { "allowAllDomains": { - "description": "Optional. If set to true, it means allowed_domains will not be enforced.", + "description": "Optional. If set to true, it means allowed_domains are not enforced.", "type": "boolean" }, "allowAmpTraffic": { @@ -2443,7 +2445,7 @@ "type": "array" }, "challengeSecurityPreference": { - "description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.", + "description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE.", "enum": [ "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED", "USABILITY", diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 8763094c6d..d2febffbac 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -849,7 +849,7 @@ } } }, - "revision": "20240822", + "revision": "20240924", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,6 +875,42 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -968,6 +1004,19 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CertChain": { "id": "CertChain", "properties": { @@ -995,6 +1044,30 @@ }, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1058,7 +1131,7 @@ "REDIS_STANDARD_SMALL" ], "enumDescriptions": [ - "", + "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", @@ -1084,7 +1157,7 @@ "type": "array" }, "pscConnections": { - "description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.", + "description": "Output only. The list of PSC connections that are auto-created through service connectivity automation.", "items": { "$ref": "PscConnection" }, @@ -1200,12 +1273,6 @@ "readOnly": true, "type": "string" }, - "scheduleDeadlineTime": { - "description": "Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, "startTime": { "description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", @@ -1274,11 +1341,6 @@ ], "type": "string" }, - "duration": { - "description": "Duration of the time window.", - "format": "google-duration", - "type": "string" - }, "startTime": { "$ref": "TimeOfDay", "description": "Start time of the window in UTC." @@ -1822,7 +1884,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata.", + "description": "Common model for database resource instance metadata. Next ID: 23", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -1866,6 +1928,20 @@ "$ref": "CustomMetadataData", "description": "Any custom metadata associated with the resource" }, + "edition": { + "description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", + "enum": [ + "EDITION_UNSPECIFIED", + "EDITION_ENTERPRISE", + "EDITION_ENTERPRISE_PLUS" + ], + "enumDescriptions": [ + "Default, to make it consistent with instance edition enum.", + "Represents the enterprise edition.", + "Represents the enterprise plus edition." + ], + "type": "string" + }, "entitlements": { "description": "Entitlements associated with the resource", "items": { @@ -1949,6 +2025,10 @@ "$ref": "DatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, + "primaryResourceLocation": { + "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", + "type": "string" + }, "product": { "$ref": "Product", "description": "The product this resource represents." @@ -1961,6 +2041,10 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "tagsSet": { + "$ref": "Tags", + "description": "Optional. Tags associated with this resources." + }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -2276,6 +2360,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2349,6 +2445,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2770,6 +2877,131 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2890,6 +3122,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -2903,6 +3193,11 @@ "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" + }, + "shardCount": { + "description": "Optional. Number of shards (if applicable).", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -3250,6 +3545,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3380,27 +3686,27 @@ "id": "PscConnection", "properties": { "address": { - "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.", - "readOnly": true, + "description": "Required. The IP allocated on the consumer network for the PSC forwarding rule.", "type": "string" }, "forwardingRule": { - "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", - "readOnly": true, + "description": "Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", "type": "string" }, "network": { - "description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", + "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, "projectId": { - "description": "Output only. The consumer project_id where the forwarding rule is created from.", - "readOnly": true, + "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" }, "pscConnectionId": { - "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.", - "readOnly": true, + "description": "Required. The PSC connection id of the forwarding rule connected to the service attachment.", + "type": "string" + }, + "serviceAttachment": { + "description": "Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.", "type": "string" } }, @@ -3467,6 +3773,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3483,6 +3808,44 @@ }, "type": "object" }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3540,6 +3903,11 @@ "RetentionSettings": { "id": "RetentionSettings", "properties": { + "durationBasedRetention": { + "description": "Duration based retention period i.e. 172800 seconds (2 days)", + "format": "google-duration", + "type": "string" + }, "quantityBasedRetention": { "format": "int32", "type": "integer" @@ -3550,12 +3918,14 @@ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", + "DURATION", "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", - "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", + "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ], "type": "string" @@ -3567,6 +3937,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -3605,6 +3995,32 @@ }, "type": "object" }, + "Tags": { + "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", + "id": "Tags", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The Tag key/value mappings.", + "type": "object" + } + }, + "type": "object" + }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -3770,6 +4186,15 @@ }, "type": "object" }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" + }, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index 1bd9d05eb8..4fd9d2fa7b 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -849,7 +849,7 @@ } } }, - "revision": "20240822", + "revision": "20240924", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -875,6 +875,42 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AvailabilityConfiguration": { "description": "Configuration for availability of database instance", "id": "AvailabilityConfiguration", @@ -968,6 +1004,19 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CertChain": { "id": "CertChain", "properties": { @@ -995,6 +1044,30 @@ }, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "Cluster": { "description": "A cluster instance.", "id": "Cluster", @@ -1058,7 +1131,7 @@ "REDIS_STANDARD_SMALL" ], "enumDescriptions": [ - "", + "Node type unspecified", "Redis shared core nano node_type.", "Redis highmem medium node_type.", "Redis highmem xlarge node_type.", @@ -1084,7 +1157,7 @@ "type": "array" }, "pscConnections": { - "description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.", + "description": "Output only. The list of PSC connections that are auto-created through service connectivity automation.", "items": { "$ref": "PscConnection" }, @@ -1200,12 +1273,6 @@ "readOnly": true, "type": "string" }, - "scheduleDeadlineTime": { - "description": "Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, "startTime": { "description": "Output only. The start time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime", @@ -1274,11 +1341,6 @@ ], "type": "string" }, - "duration": { - "description": "Duration of the time window.", - "format": "google-duration", - "type": "string" - }, "startTime": { "$ref": "TimeOfDay", "description": "Start time of the window in UTC." @@ -1822,7 +1884,7 @@ "type": "object" }, "DatabaseResourceMetadata": { - "description": "Common model for database resource instance metadata.", + "description": "Common model for database resource instance metadata. Next ID: 23", "id": "DatabaseResourceMetadata", "properties": { "availabilityConfiguration": { @@ -1866,6 +1928,20 @@ "$ref": "CustomMetadataData", "description": "Any custom metadata associated with the resource" }, + "edition": { + "description": "Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance.", + "enum": [ + "EDITION_UNSPECIFIED", + "EDITION_ENTERPRISE", + "EDITION_ENTERPRISE_PLUS" + ], + "enumDescriptions": [ + "Default, to make it consistent with instance edition enum.", + "Represents the enterprise edition.", + "Represents the enterprise plus edition." + ], + "type": "string" + }, "entitlements": { "description": "Entitlements associated with the resource", "items": { @@ -1949,6 +2025,10 @@ "$ref": "DatabaseResourceId", "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional." }, + "primaryResourceLocation": { + "description": "Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional.", + "type": "string" + }, "product": { "$ref": "Product", "description": "The product this resource represents." @@ -1961,6 +2041,10 @@ "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, + "tagsSet": { + "$ref": "Tags", + "description": "Optional. Tags associated with this resources." + }, "updationTime": { "description": "The time at which the resource was updated and recorded at partner service.", "format": "google-datetime", @@ -2276,6 +2360,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DiscoveryEndpoint": { "description": "Endpoints on each network, for Redis clients to connect to the cluster.", "id": "DiscoveryEndpoint", @@ -2349,6 +2445,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "FailoverInstanceRequest": { "description": "Request for Failover.", "id": "FailoverInstanceRequest", @@ -2777,6 +2884,131 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2897,6 +3129,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "MachineConfiguration", @@ -2910,6 +3200,11 @@ "description": "Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix.", "format": "int64", "type": "string" + }, + "shardCount": { + "description": "Optional. Number of shards (if applicable).", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -3257,6 +3552,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Product": { "description": "Product specification for Condor resources.", "id": "Product", @@ -3387,27 +3693,27 @@ "id": "PscConnection", "properties": { "address": { - "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.", - "readOnly": true, + "description": "Required. The IP allocated on the consumer network for the PSC forwarding rule.", "type": "string" }, "forwardingRule": { - "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", - "readOnly": true, + "description": "Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", "type": "string" }, "network": { - "description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", + "description": "Required. The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", "type": "string" }, "projectId": { - "description": "Output only. The consumer project_id where the forwarding rule is created from.", - "readOnly": true, + "description": "Optional. Project ID of the consumer project where the forwarding rule is created in.", "type": "string" }, "pscConnectionId": { - "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.", - "readOnly": true, + "description": "Required. The PSC connection id of the forwarding rule connected to the service attachment.", + "type": "string" + }, + "serviceAttachment": { + "description": "Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id}/regions/{region}/serviceAttachments/{service-attachment-id}.", "type": "string" } }, @@ -3474,6 +3780,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RemoteCluster": { "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", "id": "RemoteCluster", @@ -3490,6 +3815,44 @@ }, "type": "object" }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "RescheduleClusterMaintenanceRequest": { "description": "Request for rescheduling a cluster maintenance.", "id": "RescheduleClusterMaintenanceRequest", @@ -3547,6 +3910,11 @@ "RetentionSettings": { "id": "RetentionSettings", "properties": { + "durationBasedRetention": { + "description": "Duration based retention period i.e. 172800 seconds (2 days)", + "format": "google-duration", + "type": "string" + }, "quantityBasedRetention": { "format": "int32", "type": "integer" @@ -3557,12 +3925,14 @@ "RETENTION_UNIT_UNSPECIFIED", "COUNT", "TIME", + "DURATION", "RETENTION_UNIT_OTHER" ], "enumDescriptions": [ "Backup retention unit is unspecified, will be treated as COUNT.", "Retention will be by count, eg. \"retain the most recent 7 backups\".", - "Retention will be by Time, eg. \"retain the last 7 days backups\".", + "Retention will be by Time, eg. \"retain backups till a specific time\" i.e. till 2024-05-01T00:00:00Z.", + "Retention will be by duration, eg. \"retain the backups for 172800 seconds (2 days)\".", "For rest of the other category" ], "type": "string" @@ -3574,6 +3944,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "StateInfo": { "description": "Represents additional information about the state of the cluster.", "id": "StateInfo", @@ -3612,6 +4002,32 @@ }, "type": "object" }, + "Tags": { + "description": "Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag.", + "id": "Tags", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "The Tag key/value mappings.", + "type": "object" + } + }, + "type": "object" + }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TimeOfDay": { "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", "id": "TimeOfDay", @@ -3777,6 +4193,15 @@ }, "type": "object" }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" + }, "ZoneDistributionConfig": { "description": "Zone distribution config for allocation of cluster resources.", "id": "ZoneDistributionConfig", diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index 7f90abf18f..1b400614f0 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -281,6 +281,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.getGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+catalog}/generativeQuestionFeature", + "response": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all the Catalogs associated with the project.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs", @@ -446,6 +471,74 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateGenerativeQuestion": { + "description": "Allows management of individual questions.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestion", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+catalog}/generativeQuestion", + "request": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2/{+catalog}/generativeQuestionFeature", + "request": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1133,6 +1226,67 @@ } } }, + "generativeQuestion": { + "methods": { + "batchUpdate": { + "description": "Allows management of multiple questions.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.generativeQuestion.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/generativeQuestion:batchUpdate", + "request": { + "$ref": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "generativeQuestions": { + "methods": { + "list": { + "description": "Returns all questions for a given catalog.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.generativeQuestions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/generativeQuestions", + "response": { + "$ref": "GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "models": { "methods": { "create": { @@ -2092,7 +2246,7 @@ } } }, - "revision": "20240822", + "revision": "20240920", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2400,6 +2554,34 @@ }, "type": "object" }, + "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest": { + "description": "Request for BatchUpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest", + "properties": { + "requests": { + "description": "Required. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse": { + "description": "Aggregated response for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "Optional. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2BigQueryOutputResult": { "description": "A BigQuery output result.", "id": "GoogleCloudRetailV2BigQueryOutputResult", @@ -3170,6 +3352,68 @@ }, "type": "object" }, + "GoogleCloudRetailV2GenerativeQuestionConfig": { + "description": "Configuration for a single generated question.", + "id": "GoogleCloudRetailV2GenerativeQuestionConfig", + "properties": { + "allowedInConversation": { + "description": "Optional. Whether the question is asked at serving time.", + "type": "boolean" + }, + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "exampleValues": { + "description": "Output only. Values that can be used to answer the question.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "facet": { + "description": "Required. The facet to which the question is associated.", + "type": "string" + }, + "finalQuestion": { + "description": "Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.", + "type": "string" + }, + "frequency": { + "description": "Output only. The ratio of how often a question was asked.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "generatedQuestion": { + "description": "Output only. The LLM generated question.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig": { + "description": "Configuration for overall generative question feature state.", + "id": "GoogleCloudRetailV2GenerativeQuestionsFeatureConfig", + "properties": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "featureEnabled": { + "description": "Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.", + "type": "boolean" + }, + "minimumProducts": { + "description": "Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudRetailV2GetDefaultBranchResponse": { "description": "Response message of CatalogService.GetDefaultBranch.", "id": "GoogleCloudRetailV2GetDefaultBranchResponse", @@ -3448,6 +3692,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse": { + "description": "Response for ListQuestions method.", + "id": "GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "All the questions for a given catalog.", + "items": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ListModelsResponse": { "description": "Response to a ListModelRequest.", "id": "GoogleCloudRetailV2ListModelsResponse", @@ -4149,6 +4407,36 @@ }, "type": "object" }, + "GoogleCloudRetailV2ProductAttributeInterval": { + "description": "Product attribute name and numeric interval.", + "id": "GoogleCloudRetailV2ProductAttributeInterval", + "properties": { + "interval": { + "$ref": "GoogleCloudRetailV2Interval", + "description": "The numeric interval (e.g. [10, 20))" + }, + "name": { + "description": "The attribute name (e.g. \"length\")", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2ProductAttributeValue": { + "description": "Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`.", + "id": "GoogleCloudRetailV2ProductAttributeValue", + "properties": { + "name": { + "description": "The attribute name.", + "type": "string" + }, + "value": { + "description": "The attribute value.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ProductDetail": { "description": "Detailed product information associated with a user event.", "id": "GoogleCloudRetailV2ProductDetail", @@ -4785,6 +5073,10 @@ "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, + "conversationalSearchSpec": { + "$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpec", + "description": "Optional. This field specifies all conversational related parameters addition to traditional retail search." + }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2SearchRequestDynamicFacetSpec", "deprecated": true, @@ -4867,6 +5159,10 @@ "$ref": "GoogleCloudRetailV2SearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction will take effect." }, + "tileNavigationSpec": { + "$ref": "GoogleCloudRetailV2SearchRequestTileNavigationSpec", + "description": "Optional. This field specifies tile navigation related parameters." + }, "userInfo": { "$ref": "GoogleCloudRetailV2UserInfo", "description": "User information." @@ -4919,6 +5215,59 @@ }, "type": "object" }, + "GoogleCloudRetailV2SearchRequestConversationalSearchSpec": { + "description": "This field specifies all conversational related parameters addition to traditional retail search.", + "id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpec", + "properties": { + "conversationId": { + "description": "This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "followupConversationRequested": { + "description": "This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer", + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer": { + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "description": "This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "This field specifies the selected answer which is a attribute key-value." + }, + "productAttributeValues": { + "deprecated": true, + "description": "This field is deprecated and should not be set.", + "items": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2SearchRequestDynamicFacetSpec": { "description": "The specifications of dynamically generated facets.", "id": "GoogleCloudRetailV2SearchRequestDynamicFacetSpec", @@ -5089,6 +5438,24 @@ }, "type": "object" }, + "GoogleCloudRetailV2SearchRequestTileNavigationSpec": { + "description": "This field specifies tile navigation related parameters.", + "id": "GoogleCloudRetailV2SearchRequestTileNavigationSpec", + "properties": { + "appliedTiles": { + "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "items": { + "$ref": "GoogleCloudRetailV2Tile" + }, + "type": "array" + }, + "tileNavigationRequested": { + "description": "This field specifies whether the customer would like to request tile navigation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudRetailV2SearchResponse": { "description": "Response message for SearchService.Search method.", "id": "GoogleCloudRetailV2SearchResponse", @@ -5104,6 +5471,10 @@ "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", "type": "string" }, + "conversationalSearchResult": { + "$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search." + }, "correctedQuery": { "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", "type": "string" @@ -5148,6 +5519,10 @@ }, "type": "array" }, + "tileNavigationResult": { + "$ref": "GoogleCloudRetailV2SearchResponseTileNavigationResult", + "description": "This field specifies all related information for tile navigation that will be used in client side." + }, "totalSize": { "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", "format": "int32", @@ -5156,6 +5531,66 @@ }, "type": "object" }, + "GoogleCloudRetailV2SearchResponseConversationalSearchResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search.", + "id": "GoogleCloudRetailV2SearchResponseConversationalSearchResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request." + }, + "additionalFilters": { + "deprecated": true, + "description": "This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`.", + "items": { + "$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter" + }, + "type": "array" + }, + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.", + "type": "string" + }, + "followupQuestion": { + "description": "The follow-up question. e.g., `What is the color?`", + "type": "string" + }, + "refinedQuery": { + "description": "The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer": { + "description": "Suggested answers to the follow-up question.", + "id": "GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, "GoogleCloudRetailV2SearchResponseFacet": { "description": "A facet result.", "id": "GoogleCloudRetailV2SearchResponseFacet", @@ -5266,6 +5701,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2SearchResponseTileNavigationResult": { + "description": "This field specifies all related information for tile navigation that will be used in client side.", + "id": "GoogleCloudRetailV2SearchResponseTileNavigationResult", + "properties": { + "tiles": { + "description": "The current tiles that are used for tile navigation, sorted by engagement.", + "items": { + "$ref": "GoogleCloudRetailV2Tile" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2ServingConfig": { "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).", "id": "GoogleCloudRetailV2ServingConfig", @@ -5459,6 +5908,25 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2Tile": { + "description": "This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.", + "id": "GoogleCloudRetailV2Tile", + "properties": { + "productAttributeInterval": { + "$ref": "GoogleCloudRetailV2ProductAttributeInterval", + "description": "The product attribute key-numeric interval." + }, + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2ProductAttributeValue", + "description": "The product attribute key-value." + }, + "representativeProductId": { + "description": "The representative product id for this tile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2TuneModelMetadata": { "description": "Metadata associated with a tune operation.", "id": "GoogleCloudRetailV2TuneModelMetadata", @@ -5482,6 +5950,22 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest": { + "description": "Request for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest", + "properties": { + "generativeQuestionConfig": { + "$ref": "GoogleCloudRetailV2GenerativeQuestionConfig", + "description": "Required. The question to update." + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2UserEvent": { "description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2UserEvent", diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 4bc9f7522f..d8380f50ff 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -479,6 +479,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.getGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+catalog}/generativeQuestionFeature", + "response": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all the Catalogs associated with the project.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs", @@ -644,6 +669,74 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateGenerativeQuestion": { + "description": "Allows management of individual questions.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestion", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2alpha/{+catalog}/generativeQuestion", + "request": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2alpha/{+catalog}/generativeQuestionFeature", + "request": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1512,6 +1605,67 @@ } } }, + "generativeQuestion": { + "methods": { + "batchUpdate": { + "description": "Allows management of multiple questions.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.generativeQuestion.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}/generativeQuestion:batchUpdate", + "request": { + "$ref": "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "generativeQuestions": { + "methods": { + "list": { + "description": "Returns all questions for a given catalog.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.generativeQuestions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}/generativeQuestions", + "response": { + "$ref": "GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "merchantCenterAccountLinks": { "methods": { "create": { @@ -2613,7 +2767,7 @@ } } }, - "revision": "20240822", + "revision": "20240920", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3588,6 +3742,34 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest": { + "description": "Request for BatchUpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest", + "properties": { + "requests": { + "description": "Required. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse": { + "description": "Aggregated response for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "Optional. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaBigQueryOutputResult": { "description": "A BigQuery output result.", "id": "GoogleCloudRetailV2alphaBigQueryOutputResult", @@ -4637,6 +4819,68 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaGenerativeQuestionConfig": { + "description": "Configuration for a single generated question.", + "id": "GoogleCloudRetailV2alphaGenerativeQuestionConfig", + "properties": { + "allowedInConversation": { + "description": "Optional. Whether the question is asked at serving time.", + "type": "boolean" + }, + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "exampleValues": { + "description": "Output only. Values that can be used to answer the question.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "facet": { + "description": "Required. The facet to which the question is associated.", + "type": "string" + }, + "finalQuestion": { + "description": "Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.", + "type": "string" + }, + "frequency": { + "description": "Output only. The ratio of how often a question was asked.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "generatedQuestion": { + "description": "Output only. The LLM generated question.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig": { + "description": "Configuration for overall generative question feature state.", + "id": "GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig", + "properties": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "featureEnabled": { + "description": "Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.", + "type": "boolean" + }, + "minimumProducts": { + "description": "Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaGetDefaultBranchResponse": { "description": "Response message of CatalogService.GetDefaultBranch.", "id": "GoogleCloudRetailV2alphaGetDefaultBranchResponse", @@ -4961,6 +5205,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse": { + "description": "Response for ListQuestions method.", + "id": "GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "All the questions for a given catalog.", + "items": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse": { "description": "Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.", "id": "GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse", @@ -5972,6 +6230,36 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaProductAttributeInterval": { + "description": "Product attribute name and numeric interval.", + "id": "GoogleCloudRetailV2alphaProductAttributeInterval", + "properties": { + "interval": { + "$ref": "GoogleCloudRetailV2alphaInterval", + "description": "The numeric interval (e.g. [10, 20))" + }, + "name": { + "description": "The attribute name (e.g. \"length\")", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaProductAttributeValue": { + "description": "Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`.", + "id": "GoogleCloudRetailV2alphaProductAttributeValue", + "properties": { + "name": { + "description": "The attribute name.", + "type": "string" + }, + "value": { + "description": "The attribute value.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaProductDetail": { "description": "Detailed product information associated with a user event.", "id": "GoogleCloudRetailV2alphaProductDetail", @@ -6638,6 +6926,10 @@ "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, + "conversationalSearchSpec": { + "$ref": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec", + "description": "Optional. This field specifies all conversational related parameters addition to traditional retail search." + }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec", "deprecated": true, @@ -6738,6 +7030,10 @@ "$ref": "GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction will take effect." }, + "tileNavigationSpec": { + "$ref": "GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec", + "description": "Optional. This field specifies tile navigation related parameters." + }, "userInfo": { "$ref": "GoogleCloudRetailV2alphaUserInfo", "description": "User information." @@ -6790,6 +7086,59 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec": { + "description": "This field specifies all conversational related parameters addition to traditional retail search.", + "id": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec", + "properties": { + "conversationId": { + "description": "This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "followupConversationRequested": { + "description": "This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer", + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer": { + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "description": "This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "This field specifies the selected answer which is a attribute key-value." + }, + "productAttributeValues": { + "deprecated": true, + "description": "This field is deprecated and should not be set.", + "items": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec": { "description": "The specifications of dynamically generated facets.", "id": "GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec", @@ -6960,6 +7309,24 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec": { + "description": "This field specifies tile navigation related parameters.", + "id": "GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec", + "properties": { + "appliedTiles": { + "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "items": { + "$ref": "GoogleCloudRetailV2alphaTile" + }, + "type": "array" + }, + "tileNavigationRequested": { + "description": "This field specifies whether the customer would like to request tile navigation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaSearchResponse": { "description": "Response message for SearchService.Search method.", "id": "GoogleCloudRetailV2alphaSearchResponse", @@ -6975,6 +7342,10 @@ "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", "type": "string" }, + "conversationalSearchResult": { + "$ref": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search." + }, "correctedQuery": { "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", "type": "string" @@ -7019,6 +7390,10 @@ }, "type": "array" }, + "tileNavigationResult": { + "$ref": "GoogleCloudRetailV2alphaSearchResponseTileNavigationResult", + "description": "This field specifies all related information for tile navigation that will be used in client side." + }, "totalSize": { "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", "format": "int32", @@ -7027,6 +7402,66 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search.", + "id": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request." + }, + "additionalFilters": { + "deprecated": true, + "description": "This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`.", + "items": { + "$ref": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter" + }, + "type": "array" + }, + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.", + "type": "string" + }, + "followupQuestion": { + "description": "The follow-up question. e.g., `What is the color?`", + "type": "string" + }, + "refinedQuery": { + "description": "The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer": { + "description": "Suggested answers to the follow-up question.", + "id": "GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaSearchResponseFacet": { "description": "A facet result.", "id": "GoogleCloudRetailV2alphaSearchResponseFacet", @@ -7137,6 +7572,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaSearchResponseTileNavigationResult": { + "description": "This field specifies all related information for tile navigation that will be used in client side.", + "id": "GoogleCloudRetailV2alphaSearchResponseTileNavigationResult", + "properties": { + "tiles": { + "description": "The current tiles that are used for tile navigation, sorted by engagement.", + "items": { + "$ref": "GoogleCloudRetailV2alphaTile" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaServingConfig": { "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).", "id": "GoogleCloudRetailV2alphaServingConfig", @@ -7330,6 +7779,25 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2alphaTile": { + "description": "This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.", + "id": "GoogleCloudRetailV2alphaTile", + "properties": { + "productAttributeInterval": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeInterval", + "description": "The product attribute key-numeric interval." + }, + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2alphaProductAttributeValue", + "description": "The product attribute key-value." + }, + "representativeProductId": { + "description": "The representative product id for this tile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaTransformedUserEventsMetadata": { "description": "Metadata related to transform user events operation.", "id": "GoogleCloudRetailV2alphaTransformedUserEventsMetadata", @@ -7370,6 +7838,22 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest": { + "description": "Request for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest", + "properties": { + "generativeQuestionConfig": { + "$ref": "GoogleCloudRetailV2alphaGenerativeQuestionConfig", + "description": "Required. The question to update." + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaUserEvent": { "description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2alphaUserEvent", diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 37fa3394d2..5f32bf6d94 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -342,6 +342,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.getGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+catalog}/generativeQuestionFeature", + "response": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all the Catalogs associated with the project.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs", @@ -507,6 +532,74 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateGenerativeQuestion": { + "description": "Allows management of individual questions.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestion", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta/{+catalog}/generativeQuestion", + "request": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateGenerativeQuestionFeature": { + "description": "Manages overal generative question feature state -- enables toggling feature on and off.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature", + "httpMethod": "PATCH", + "id": "retail.projects.locations.catalogs.updateGenerativeQuestionFeature", + "parameterOrder": [ + "catalog" + ], + "parameters": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta/{+catalog}/generativeQuestionFeature", + "request": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1250,6 +1343,67 @@ } } }, + "generativeQuestion": { + "methods": { + "batchUpdate": { + "description": "Allows management of multiple questions.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.generativeQuestion.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+parent}/generativeQuestion:batchUpdate", + "request": { + "$ref": "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "generativeQuestions": { + "methods": { + "list": { + "description": "Returns all questions for a given catalog.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions", + "httpMethod": "GET", + "id": "retail.projects.locations.catalogs.generativeQuestions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+parent}/generativeQuestions", + "response": { + "$ref": "GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "models": { "methods": { "create": { @@ -2237,7 +2391,7 @@ } } }, - "revision": "20240822", + "revision": "20240920", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4036,6 +4190,34 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest": { + "description": "Request for BatchUpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest", + "properties": { + "requests": { + "description": "Required. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2betaUpdateGenerativeQuestionConfigRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse": { + "description": "Aggregated response for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "Optional. The updates question configs.", + "items": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaBigQueryOutputResult": { "description": "A BigQuery output result.", "id": "GoogleCloudRetailV2betaBigQueryOutputResult", @@ -4903,6 +5085,68 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaGenerativeQuestionConfig": { + "description": "Configuration for a single generated question.", + "id": "GoogleCloudRetailV2betaGenerativeQuestionConfig", + "properties": { + "allowedInConversation": { + "description": "Optional. Whether the question is asked at serving time.", + "type": "boolean" + }, + "catalog": { + "description": "Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "exampleValues": { + "description": "Output only. Values that can be used to answer the question.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "facet": { + "description": "Required. The facet to which the question is associated.", + "type": "string" + }, + "finalQuestion": { + "description": "Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.", + "type": "string" + }, + "frequency": { + "description": "Output only. The ratio of how often a question was asked.", + "format": "float", + "readOnly": true, + "type": "number" + }, + "generatedQuestion": { + "description": "Output only. The LLM generated question.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig": { + "description": "Configuration for overall generative question feature state.", + "id": "GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig", + "properties": { + "catalog": { + "description": "Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}", + "type": "string" + }, + "featureEnabled": { + "description": "Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied.", + "type": "boolean" + }, + "minimumProducts": { + "description": "Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaGetDefaultBranchResponse": { "description": "Response message of CatalogService.GetDefaultBranch.", "id": "GoogleCloudRetailV2betaGetDefaultBranchResponse", @@ -5181,6 +5425,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse": { + "description": "Response for ListQuestions method.", + "id": "GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse", + "properties": { + "generativeQuestionConfigs": { + "description": "All the questions for a given catalog.", + "items": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaListModelsResponse": { "description": "Response to a ListModelRequest.", "id": "GoogleCloudRetailV2betaListModelsResponse", @@ -5950,6 +6208,36 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaProductAttributeInterval": { + "description": "Product attribute name and numeric interval.", + "id": "GoogleCloudRetailV2betaProductAttributeInterval", + "properties": { + "interval": { + "$ref": "GoogleCloudRetailV2betaInterval", + "description": "The numeric interval (e.g. [10, 20))" + }, + "name": { + "description": "The attribute name (e.g. \"length\")", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaProductAttributeValue": { + "description": "Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`.", + "id": "GoogleCloudRetailV2betaProductAttributeValue", + "properties": { + "name": { + "description": "The attribute name.", + "type": "string" + }, + "value": { + "description": "The attribute value.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaProductDetail": { "description": "Detailed product information associated with a user event.", "id": "GoogleCloudRetailV2betaProductDetail", @@ -6586,6 +6874,10 @@ "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, + "conversationalSearchSpec": { + "$ref": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpec", + "description": "Optional. This field specifies all conversational related parameters addition to traditional retail search." + }, "dynamicFacetSpec": { "$ref": "GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec", "deprecated": true, @@ -6668,6 +6960,10 @@ "$ref": "GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction will take effect." }, + "tileNavigationSpec": { + "$ref": "GoogleCloudRetailV2betaSearchRequestTileNavigationSpec", + "description": "Optional. This field specifies tile navigation related parameters." + }, "userInfo": { "$ref": "GoogleCloudRetailV2betaUserInfo", "description": "User information." @@ -6720,6 +7016,59 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpec": { + "description": "This field specifies all conversational related parameters addition to traditional retail search.", + "id": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpec", + "properties": { + "conversationId": { + "description": "This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty.", + "type": "string" + }, + "followupConversationRequested": { + "description": "This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc.", + "type": "boolean" + }, + "userAnswer": { + "$ref": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswer", + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswer": { + "description": "This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.", + "id": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswer", + "properties": { + "selectedAnswer": { + "$ref": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "description": "This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers." + }, + "textAnswer": { + "description": "This field specifies the incremental input text from the user during the conversational search.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer": { + "description": "This field specifies the selected answers during the conversational search.", + "id": "GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "This field specifies the selected answer which is a attribute key-value." + }, + "productAttributeValues": { + "deprecated": true, + "description": "This field is deprecated and should not be set.", + "items": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec": { "description": "The specifications of dynamically generated facets.", "id": "GoogleCloudRetailV2betaSearchRequestDynamicFacetSpec", @@ -6890,6 +7239,24 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaSearchRequestTileNavigationSpec": { + "description": "This field specifies tile navigation related parameters.", + "id": "GoogleCloudRetailV2betaSearchRequestTileNavigationSpec", + "properties": { + "appliedTiles": { + "description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.", + "items": { + "$ref": "GoogleCloudRetailV2betaTile" + }, + "type": "array" + }, + "tileNavigationRequested": { + "description": "This field specifies whether the customer would like to request tile navigation.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaSearchResponse": { "description": "Response message for SearchService.Search method.", "id": "GoogleCloudRetailV2betaSearchResponse", @@ -6905,6 +7272,10 @@ "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", "type": "string" }, + "conversationalSearchResult": { + "$ref": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResult", + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search." + }, "correctedQuery": { "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", "type": "string" @@ -6949,6 +7320,10 @@ }, "type": "array" }, + "tileNavigationResult": { + "$ref": "GoogleCloudRetailV2betaSearchResponseTileNavigationResult", + "description": "This field specifies all related information for tile navigation that will be used in client side." + }, "totalSize": { "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", "format": "int32", @@ -6957,6 +7332,66 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaSearchResponseConversationalSearchResult": { + "description": "This field specifies all related information that is needed on client side for UI rendering of conversational retail search.", + "id": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResult", + "properties": { + "additionalFilter": { + "$ref": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter", + "description": "This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request." + }, + "additionalFilters": { + "deprecated": true, + "description": "This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`.", + "items": { + "$ref": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter" + }, + "type": "array" + }, + "conversationId": { + "description": "Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server.", + "type": "string" + }, + "followupQuestion": { + "description": "The follow-up question. e.g., `What is the color?`", + "type": "string" + }, + "refinedQuery": { + "description": "The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`.", + "type": "string" + }, + "suggestedAnswers": { + "description": "The answer options provided to client for the follow-up question.", + "items": { + "$ref": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultSuggestedAnswer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter": { + "description": "Additional filter that client side need to apply.", + "id": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultSuggestedAnswer": { + "description": "Suggested answers to the follow-up question.", + "id": "GoogleCloudRetailV2betaSearchResponseConversationalSearchResultSuggestedAnswer", + "properties": { + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future." + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaSearchResponseFacet": { "description": "A facet result.", "id": "GoogleCloudRetailV2betaSearchResponseFacet", @@ -7067,6 +7502,20 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaSearchResponseTileNavigationResult": { + "description": "This field specifies all related information for tile navigation that will be used in client side.", + "id": "GoogleCloudRetailV2betaSearchResponseTileNavigationResult", + "properties": { + "tiles": { + "description": "The current tiles that are used for tile navigation, sorted by engagement.", + "items": { + "$ref": "GoogleCloudRetailV2betaTile" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaServingConfig": { "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).", "id": "GoogleCloudRetailV2betaServingConfig", @@ -7260,6 +7709,25 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2betaTile": { + "description": "This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.", + "id": "GoogleCloudRetailV2betaTile", + "properties": { + "productAttributeInterval": { + "$ref": "GoogleCloudRetailV2betaProductAttributeInterval", + "description": "The product attribute key-numeric interval." + }, + "productAttributeValue": { + "$ref": "GoogleCloudRetailV2betaProductAttributeValue", + "description": "The product attribute key-value." + }, + "representativeProductId": { + "description": "The representative product id for this tile.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaTuneModelMetadata": { "description": "Metadata associated with a tune operation.", "id": "GoogleCloudRetailV2betaTuneModelMetadata", @@ -7283,6 +7751,22 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2betaUpdateGenerativeQuestionConfigRequest": { + "description": "Request for UpdateGenerativeQuestionConfig method.", + "id": "GoogleCloudRetailV2betaUpdateGenerativeQuestionConfigRequest", + "properties": { + "generativeQuestionConfig": { + "$ref": "GoogleCloudRetailV2betaGenerativeQuestionConfig", + "description": "Required. The question to update." + }, + "updateMask": { + "description": "Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaUserEvent": { "description": "UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.", "id": "GoogleCloudRetailV2betaUserEvent", diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 74c691efd2..4b38f83514 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2614,7 +2614,7 @@ } } }, - "revision": "20240802", + "revision": "20240927", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2934,7 +2934,7 @@ }, "readinessProbe": { "$ref": "Probe", - "description": "Not supported by Cloud Run." + "description": "Readiness probe to be used for health checks. Not supported by Cloud Run." }, "resources": { "$ref": "ResourceRequirements", @@ -3801,11 +3801,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, @@ -5381,7 +5383,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-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/enable-automatic-updates`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/image-uri`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", + "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/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": { diff --git a/discovery/run-v2.json b/discovery/run-v2.json index c29e62035a..7c80c2bd79 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1526,7 +1526,7 @@ } } }, - "revision": "20240823", + "revision": "20240927", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2984,7 +2984,7 @@ "id": "GoogleCloudRunV2RevisionScaling", "properties": { "maxInstanceCount": { - "description": "Optional. Maximum number of serving instances that this resource should have.", + "description": "Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances", "format": "int32", "type": "integer" }, @@ -3258,6 +3258,10 @@ ], "type": "string" }, + "invokerIamDisabled": { + "description": "Optional. Disables IAM permission check for run.routes.invoke for callers of this service. This setting should not be used with external ingress.", + "type": "boolean" + }, "labels": { "additionalProperties": { "type": "string" @@ -3395,9 +3399,23 @@ "id": "GoogleCloudRunV2ServiceScaling", "properties": { "minInstanceCount": { - "description": "Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (BETA)", + "description": "Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving.", "format": "int32", "type": "integer" + }, + "scalingMode": { + "description": "Optional. The scaling mode for the service.", + "enum": [ + "SCALING_MODE_UNSPECIFIED", + "AUTOMATIC", + "MANUAL" + ], + "enumDescriptions": [ + "Unspecified.", + "Scale based on traffic between min and max instances.", + "Scale to exactly min instances and ignore max instances." + ], + "type": "string" } }, "type": "object" @@ -3468,6 +3486,10 @@ "description": "URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates.", "type": "string" }, + "baseImageWarning": { + "description": "Warning message for the base image.", + "type": "string" + }, "buildOperation": { "$ref": "GoogleLongrunningOperation", "description": "Cloud Build operation to be polled via CloudBuild API." @@ -4291,11 +4313,13 @@ "description": "Optional. Option to specify how default logs buckets are setup.", "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", - "REGIONAL_USER_OWNED_BUCKET" + "REGIONAL_USER_OWNED_BUCKET", + "LEGACY_BUCKET" ], "enumDescriptions": [ "Unspecified.", - "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project." + "Bucket is located in user-owned project in the same region as the build. The builder service account must have access to create and write to Cloud Storage buckets in the build project.", + "Bucket is located in a Google-owned project and is not regionalized." ], "type": "string" }, diff --git a/discovery/searchads360-v0.json b/discovery/searchads360-v0.json index 9762c2db9e..22fd45fb47 100644 --- a/discovery/searchads360-v0.json +++ b/discovery/searchads360-v0.json @@ -260,7 +260,7 @@ } } }, - "revision": "20240822", + "revision": "20241002", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -1170,11 +1170,21 @@ "format": "double", "type": "number" }, + "crossDeviceConversionsByConversionDate": { + "description": "The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", + "format": "double", + "type": "number" + }, "crossDeviceConversionsValue": { "description": "The sum of the value of cross-device conversions.", "format": "double", "type": "number" }, + "crossDeviceConversionsValueByConversionDate": { + "description": "The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611.", + "format": "double", + "type": "number" + }, "crossSellCostOfGoodsSoldMicros": { "description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", "format": "int64", @@ -1200,6 +1210,16 @@ "format": "double", "type": "number" }, + "generalInvalidClickRate": { + "description": "The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", + "format": "double", + "type": "number" + }, + "generalInvalidClicks": { + "description": "Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details.", + "format": "int64", + "type": "string" + }, "historicalCreativeQualityScore": { "description": "The creative historical quality score.", "enum": [ @@ -3384,7 +3404,7 @@ "id": "GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization", "properties": { "conversionActions": { - "description": "The selected set of conversion actions for optimizing this campaign.", + "description": "The selected set of resource names for conversion actions for optimizing this campaign.", "items": { "type": "string" }, @@ -4020,6 +4040,14 @@ "readOnly": true, "type": "string" }, + "effectiveLabels": { + "description": "Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "endDate": { "description": "Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14", "readOnly": true, @@ -4761,6 +4789,31 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel": { + "description": "A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group.", + "id": "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel", + "properties": { + "adGroup": { + "description": "Immutable. The ad group to which the effective label is attached.", + "type": "string" + }, + "label": { + "description": "Immutable. The effective label assigned to the ad group.", + "type": "string" + }, + "ownerCustomerId": { + "description": "Output only. The ID of the Customer which owns the effective label.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id}/adGroupEffectiveLabels/{ad_group_id}~{label_id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__AdGroupLabel": { "description": "A relationship between an ad group and a label.", "id": "GoogleAdsSearchads360V0Resources__AdGroupLabel", @@ -5651,7 +5704,7 @@ "type": "string" }, "biddingStrategy": { - "description": "Portfolio bidding strategy used by campaign.", + "description": "The resource name of the portfolio bidding strategy used by the campaign.", "type": "string" }, "biddingStrategySystemStatus": { @@ -5765,7 +5818,7 @@ "type": "string" }, "campaignBudget": { - "description": "The budget of the campaign.", + "description": "The resource name of the campaign budget of the campaign.", "type": "string" }, "createTime": { @@ -5782,6 +5835,14 @@ "$ref": "GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting", "description": "The setting for controlling Dynamic Search Ads (DSA)." }, + "effectiveLabels": { + "description": "Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "endDate": { "description": "The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30.", "type": "string" @@ -6351,6 +6412,31 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel": { + "description": "Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign.", + "id": "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel", + "properties": { + "campaign": { + "description": "Immutable. The campaign to which the effective label is attached.", + "type": "string" + }, + "label": { + "description": "Immutable. The effective label assigned to the campaign.", + "type": "string" + }, + "ownerCustomerId": { + "description": "Output only. The ID of the Customer which owns the effective label.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id}/campaignEffectiveLabels/{campaign_id}~{label_id}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__CampaignLabel": { "description": "Represents a relationship between a campaign and a label.", "id": "GoogleAdsSearchads360V0Resources__CampaignLabel", @@ -8339,6 +8425,10 @@ "$ref": "GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel", "description": "The ad group criterion label referenced in the query." }, + "adGroupEffectiveLabel": { + "$ref": "GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel", + "description": "The ad group effective label referenced in the query." + }, "adGroupLabel": { "$ref": "GoogleAdsSearchads360V0Resources__AdGroupLabel", "description": "The ad group label referenced in the query." @@ -8411,6 +8501,10 @@ "$ref": "GoogleAdsSearchads360V0Resources__CampaignCriterion", "description": "The campaign criterion referenced in the query." }, + "campaignEffectiveLabel": { + "$ref": "GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel", + "description": "The campaign effective label referenced in the query." + }, "campaignLabel": { "$ref": "GoogleAdsSearchads360V0Resources__CampaignLabel", "description": "The campaign label referenced in the query." diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index d61b8b9786..e99cc4ee09 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -1190,7 +1190,7 @@ } } }, - "revision": "20240816", + "revision": "20240924", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { @@ -1623,7 +1623,7 @@ }, "customerManagedEncryption": { "$ref": "CustomerManagedEncryption", - "description": "Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." + "description": "Optional. The customer-managed encryption configuration of the regionalized secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions." }, "etag": { "description": "Optional. Etag of the currently stored Secret.", @@ -1716,7 +1716,7 @@ }, "customerManagedEncryption": { "$ref": "CustomerManagedEncryptionStatus", - "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret.", + "description": "Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret.", "readOnly": true }, "destroyTime": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 11c81a55ea..f9e07e8fef 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -732,39 +732,6 @@ "resources": { "muteConfigs": { "methods": { - "create": { - "description": "Creates a mute config.", - "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs", - "httpMethod": "POST", - "id": "securitycenter.folders.locations.muteConfigs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "muteConfigId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/muteConfigs", - "request": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "response": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "description": "Deletes an existing mute config.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -815,42 +782,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists mute configs.", - "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs", - "httpMethod": "GET", - "id": "securitycenter.folders.locations.muteConfigs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", - "location": "path", - "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}", - "response": { - "$ref": "ListMuteConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "patch": { "description": "Updates a mute config.", "flatPath": "v1/folders/{foldersId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -2508,39 +2439,6 @@ "resources": { "muteConfigs": { "methods": { - "create": { - "description": "Creates a mute config.", - "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs", - "httpMethod": "POST", - "id": "securitycenter.organizations.locations.muteConfigs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "muteConfigId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/muteConfigs", - "request": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "response": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "description": "Deletes an existing mute config.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -2591,42 +2489,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists mute configs.", - "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs", - "httpMethod": "GET", - "id": "securitycenter.organizations.locations.muteConfigs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", - "location": "path", - "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}", - "response": { - "$ref": "ListMuteConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "patch": { "description": "Updates a mute config.", "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -5017,39 +4879,6 @@ "resources": { "muteConfigs": { "methods": { - "create": { - "description": "Creates a mute config.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs", - "httpMethod": "POST", - "id": "securitycenter.projects.locations.muteConfigs.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "muteConfigId": { - "description": "Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}/muteConfigs", - "request": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "response": { - "$ref": "GoogleCloudSecuritycenterV1MuteConfig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "delete": { "description": "Deletes an existing mute config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -5100,42 +4929,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists mute configs.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs", - "httpMethod": "GET", - "id": "securitycenter.projects.locations.muteConfigs.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+parent}", - "response": { - "$ref": "ListMuteConfigsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "patch": { "description": "Updates a mute config.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/muteConfigs/{muteConfigsId}", @@ -6084,7 +5877,7 @@ } } }, - "revision": "20240827", + "revision": "20240926", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6630,6 +6423,10 @@ "description": "Represents an Azure resource group.", "id": "AzureResourceGroup", "properties": { + "id": { + "description": "The ID of the Azure resource group.", + "type": "string" + }, "name": { "description": "The name of the Azure resource group. This is not a UUID.", "type": "string" @@ -6656,6 +6453,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" @@ -6800,6 +6601,17 @@ }, "type": "object" }, + "CelPolicySpec": { + "description": "YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: \"compute.googleapis.com/Instance\" - resource_types: \"compute.googleapis.com/Firewall\" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies.", + "id": "CelPolicySpec", + "properties": { + "spec": { + "description": "The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false.", + "type": "string" + } + }, + "type": "object" + }, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -8238,6 +8050,10 @@ "description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { + "celPolicy": { + "$ref": "CelPolicySpec", + "description": "The CEL policy spec attached to the custom module." + }, "customOutput": { "$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", "description": "Custom output properties." @@ -9320,6 +9136,10 @@ "description": "Represents an Azure resource group.", "id": "GoogleCloudSecuritycenterV2AzureResourceGroup", "properties": { + "id": { + "description": "The ID of the Azure resource group.", + "type": "string" + }, "name": { "description": "The name of the Azure resource group. This is not a UUID.", "type": "string" @@ -9346,6 +9166,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index c7316c3337..75a5b1ceaa 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -903,7 +903,7 @@ } } }, - "revision": "20240827", + "revision": "20240926", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1313,6 +1313,10 @@ "description": "Represents an Azure resource group.", "id": "AzureResourceGroup", "properties": { + "id": { + "description": "The ID of the Azure resource group.", + "type": "string" + }, "name": { "description": "The name of the Azure resource group. This is not a UUID.", "type": "string" @@ -1339,6 +1343,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" @@ -1431,6 +1439,17 @@ "properties": {}, "type": "object" }, + "CelPolicySpec": { + "description": "YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: \"compute.googleapis.com/Instance\" - resource_types: \"compute.googleapis.com/Firewall\" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: > instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: > firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: > instance.networkInterfaces.exists(net, firewall.network == net.network) output: > {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies.", + "id": "CelPolicySpec", + "properties": { + "spec": { + "description": "The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false.", + "type": "string" + } + }, + "type": "object" + }, "CloudArmor": { "description": "Fields related to Google Cloud Armor findings.", "id": "CloudArmor", @@ -2704,6 +2723,10 @@ "description": "Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify.", "id": "GoogleCloudSecuritycenterV1CustomConfig", "properties": { + "celPolicy": { + "$ref": "CelPolicySpec", + "description": "The CEL policy spec attached to the custom module." + }, "customOutput": { "$ref": "GoogleCloudSecuritycenterV1CustomOutputSpec", "description": "Custom output properties." @@ -3867,6 +3890,10 @@ "description": "Represents an Azure resource group.", "id": "GoogleCloudSecuritycenterV2AzureResourceGroup", "properties": { + "id": { + "description": "The ID of the Azure resource group.", + "type": "string" + }, "name": { "description": "The name of the Azure resource group. This is not a UUID.", "type": "string" @@ -3893,6 +3920,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index 610096d7b8..734ed38b3d 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -512,6 +512,11 @@ "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -541,6 +546,11 @@ "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -599,6 +609,11 @@ "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -628,6 +643,11 @@ "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -657,6 +677,11 @@ "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1096,6 +1121,11 @@ "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1125,6 +1155,11 @@ "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1183,6 +1218,11 @@ "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1212,6 +1252,11 @@ "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1241,6 +1286,11 @@ "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1655,6 +1705,11 @@ "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1684,6 +1739,11 @@ "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1778,6 +1838,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1840,6 +1905,11 @@ "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1869,6 +1939,11 @@ "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1898,6 +1973,11 @@ "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, "type": "string" + }, + "showEligibleModulesOnly": { + "description": "Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown.", + "location": "query", + "type": "boolean" } }, "path": "v1beta2/{+name}:calculate", @@ -1913,7 +1993,7 @@ } } }, - "revision": "20240827", + "revision": "20240927", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2237,6 +2317,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" @@ -4806,6 +4890,10 @@ "description": "Represents a Microsoft Entra tenant.", "id": "GoogleCloudSecuritycenterV2AzureTenant", "properties": { + "displayName": { + "description": "The display name of the Azure tenant.", + "type": "string" + }, "id": { "description": "The ID of the Microsoft Entra tenant, for example, \"a11aaa11-aa11-1aa1-11aa-1aaa11a\".", "type": "string" diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index a902f01048..02e3dfa4ac 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20240712", + "revision": "20240929", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -966,6 +966,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -1340,6 +1344,17 @@ }, "type": "object" }, + "ExperimentalFeatures": { + "description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.", + "id": "ExperimentalFeatures", + "properties": { + "restAsyncIoEnabled": { + "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", + "type": "boolean" + } + }, + "type": "object" + }, "Field": { "description": "A single field of a message type.", "id": "Field", @@ -1979,6 +1994,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2003,7 +2037,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -2324,6 +2358,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." + }, + "experimentalFeatures": { + "$ref": "ExperimentalFeatures", + "description": "Experimental features to be included during client library generation." } }, "type": "object" @@ -2443,6 +2481,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", @@ -3125,7 +3177,7 @@ "id": "V1DefaultIdentity", "properties": { "email": { - "description": "The email address of the default identity.", + "description": "The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email.", "type": "string" }, "name": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index cf0a1321fc..773b916ea0 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20240712", + "revision": "20240929", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1073,6 +1073,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -1425,6 +1429,17 @@ }, "type": "object" }, + "ExperimentalFeatures": { + "description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.", + "id": "ExperimentalFeatures", + "properties": { + "restAsyncIoEnabled": { + "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", + "type": "boolean" + } + }, + "type": "object" + }, "Field": { "description": "A single field of a message type.", "id": "Field", @@ -2028,6 +2043,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2052,7 +2086,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -2355,6 +2389,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." + }, + "experimentalFeatures": { + "$ref": "ExperimentalFeatures", + "description": "Experimental features to be included during client library generation." } }, "type": "object" @@ -2445,6 +2483,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", @@ -3247,7 +3299,7 @@ "id": "V1beta1DefaultIdentity", "properties": { "email": { - "description": "The email address of the default identity.", + "description": "The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email.", "type": "string" }, "name": { diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index ad23834b04..0158aa7d28 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20240823", + "revision": "20240927", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1283,6 +1283,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -2632,7 +2636,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -3175,6 +3179,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 53bd692b86..96623fb800 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20240901", + "revision": "20240925", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1614,6 +1614,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -3001,7 +3005,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -3623,6 +3627,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index b4092523bf..6a6200400f 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20240901", + "revision": "20240925", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -775,6 +775,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -2021,7 +2025,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -2552,6 +2556,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "`Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: \"google.calendar.v3.*\" restriction: PREVIEW backend: rules: - selector: \"google.calendar.v3.*\" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: \"*\" requirements: provider_id: google_calendar_auth", "id": "Service", diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index d9788e7b35..8db04cb213 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20240811", + "revision": "20240929", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1003,6 +1003,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -1516,6 +1520,17 @@ }, "type": "object" }, + "ExperimentalFeatures": { + "description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.", + "id": "ExperimentalFeatures", + "properties": { + "restAsyncIoEnabled": { + "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", + "type": "boolean" + } + }, + "type": "object" + }, "Field": { "description": "A single field of a message type.", "id": "Field", @@ -2617,6 +2632,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -2641,7 +2675,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -2958,6 +2992,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." + }, + "experimentalFeatures": { + "$ref": "ExperimentalFeatures", + "description": "Experimental features to be included during client library generation." } }, "type": "object" @@ -3108,6 +3146,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ServiceIdentity": { "description": "Service identity for a service. This is the identity that service producer should use to access consumer resources.", "id": "ServiceIdentity", diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index faf7a5e813..9f093d9dfd 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20240811", + "revision": "20240929", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1521,6 +1521,10 @@ "deprecated": true, "description": "Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest", "type": "string" + }, + "selectiveGapicGeneration": { + "$ref": "SelectiveGapicGeneration", + "description": "Configuration for which RPCs should be generated in the GAPIC client." } }, "type": "object" @@ -2093,6 +2097,17 @@ }, "type": "object" }, + "ExperimentalFeatures": { + "description": "Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default.", + "id": "ExperimentalFeatures", + "properties": { + "restAsyncIoEnabled": { + "description": "Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages.", + "type": "boolean" + } + }, + "type": "object" + }, "Field": { "description": "A single field of a message type.", "id": "Field", @@ -3312,6 +3327,25 @@ "description": "The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.", "format": "google-duration", "type": "string" + }, + "timeSeriesResourceHierarchyLevel": { + "description": "The scope of the timeseries data of the metric.", + "items": { + "enum": [ + "TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED", + "PROJECT", + "ORGANIZATION", + "FOLDER" + ], + "enumDescriptions": [ + "Do not use this default value.", + "Scopes a metric to a project.", + "Scopes a metric to an organization.", + "Scopes a metric to a folder." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -3336,7 +3370,7 @@ "type": "object" }, "Mixin": { - "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", + "description": "Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v1/{resource=**}:getAcl\"; } } package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = \"/v2/{resource=**}\"; } } Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/{resource=**}:getAcl\"; } ... } Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\"; } ... }", "id": "Mixin", "properties": { "name": { @@ -3702,6 +3736,10 @@ "common": { "$ref": "CommonLanguageSettings", "description": "Some settings." + }, + "experimentalFeatures": { + "$ref": "ExperimentalFeatures", + "description": "Experimental features to be included during client library generation." } }, "type": "object" @@ -3907,6 +3945,20 @@ }, "type": "object" }, + "SelectiveGapicGeneration": { + "description": "This message is used to configure the generation of a subset of the RPCs in a service for client libraries.", + "id": "SelectiveGapicGeneration", + "properties": { + "methods": { + "description": "An allowlist of the fully qualified names of RPCs that should be included on public client surfaces.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Service": { "description": "A service that is available for use by the consumer.", "id": "Service", diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index 3f00fa4789..eb7519e339 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20240826", + "revision": "20240917", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -6957,7 +6957,7 @@ "description": "The default format of all cells in the spreadsheet. CellData.effectiveFormat will not be set if the cell's format is equal to this default format. This field is read-only." }, "importFunctionsExternalUrlAccessAllowed": { - "description": "Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the allowlisting feature.", + "description": "Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=url_allowlist).", "type": "boolean" }, "iterativeCalculationSettings": { diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index 5bf78d1665..53aa9378f1 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -27,15 +27,35 @@ "endpointUrl": "https://spanner.me-central2.rep.googleapis.com/", "location": "me-central2" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://spanner.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, { "description": "Regional Endpoint", "endpointUrl": "https://spanner.us-east1.rep.googleapis.com/", "location": "us-east1" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://spanner.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://spanner.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, { "description": "Regional Endpoint", "endpointUrl": "https://spanner.us-west1.rep.googleapis.com/", "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://spanner.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -3264,7 +3284,7 @@ } } }, - "revision": "20240831", + "revision": "20240918", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -4547,7 +4567,7 @@ "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results. This has a performance overhead compared to the NORMAL mode. It is not recommended to use this mode for production traffic." + "This mode returns the query plan, overall execution statistics, operator level execution statistics along with the results. This has a performance overhead compared to the other modes. It is not recommended to use this mode for production traffic." ], "type": "string" }, @@ -5647,6 +5667,23 @@ }, "type": "object" }, + "MultiplexedSessionPrecommitToken": { + "description": "When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the [Transaction] message in the BeginTransaction response and also as a part of the [ResultSet] and [PartialResultSet] responses.", + "id": "MultiplexedSessionPrecommitToken", + "properties": { + "precommitToken": { + "description": "Opaque precommit token.", + "format": "byte", + "type": "string" + }, + "seqNum": { + "description": "An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Mutation": { "description": "A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call.", "id": "Mutation", @@ -6790,6 +6827,10 @@ "format": "byte", "type": "string" }, + "precommitToken": { + "$ref": "MultiplexedSessionPrecommitToken", + "description": "A precommit token will be included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction." + }, "readTimestamp": { "description": "For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds. Example: `\"2014-10-02T15:01:23.045123456Z\"`.", "format": "google-datetime", diff --git a/discovery/speech-v1.json b/discovery/speech-v1.json index cb69973dc1..196da183c5 100644 --- a/discovery/speech-v1.json +++ b/discovery/speech-v1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20240118", + "revision": "20240926", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -1044,7 +1044,8 @@ "OGG_OPUS", "SPEEX_WITH_HEADER_BYTE", "MP3", - "WEBM_OPUS" + "WEBM_OPUS", + "ALAW" ], "enumDescriptions": [ "Not specified.", @@ -1056,7 +1057,8 @@ "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Cloud Speech API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", "MP3 audio. MP3 encoding is a Beta feature and only available in v1p1beta1. Support all standard MP3 bitrates (which range from 32-320 kbps). When using this encoding, `sample_rate_hertz` has to match the sample rate of the file being used.", - "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." + "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, diff --git a/discovery/speech-v1p1beta1.json b/discovery/speech-v1p1beta1.json index 8e19fa831d..05edd0c33c 100644 --- a/discovery/speech-v1p1beta1.json +++ b/discovery/speech-v1p1beta1.json @@ -524,7 +524,7 @@ } } }, - "revision": "20240130", + "revision": "20240926", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { @@ -1060,7 +1060,8 @@ "OGG_OPUS", "SPEEX_WITH_HEADER_BYTE", "MP3", - "WEBM_OPUS" + "WEBM_OPUS", + "ALAW" ], "enumDescriptions": [ "Not specified.", @@ -1072,7 +1073,8 @@ "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Cloud Speech API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000.", "MP3 audio. MP3 encoding is a Beta feature and only available in v1p1beta1. Support all standard MP3 bitrates (which range from 32-320 kbps). When using this encoding, `sample_rate_hertz` has to match the sample rate of the file being used.", - "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000." + "Opus encoded audio frames in WebM container ([WebM](https://www.webmproject.org/docs/container/)). `sample_rate_hertz` must be one of 8000, 12000, 16000, 24000, or 48000.", + "8-bit samples that compand 13-bit audio samples using G.711 PCMU/a-law." ], "type": "string" }, diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 70f6fa68eb..971b0ebc76 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -608,6 +608,73 @@ }, "instances": { "methods": { + "ListServerCertificates": { + "description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", + "flatPath": "v1/projects/{project}/instances/{instance}/listServerCertificates", + "httpMethod": "GET", + "id": "sql.instances.ListServerCertificates", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/listServerCertificates", + "response": { + "$ref": "InstancesListServerCertificatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "RotateServerCertificate": { + "description": "Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.", + "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", + "httpMethod": "POST", + "id": "sql.instances.RotateServerCertificate", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/rotateServerCertificate", + "request": { + "$ref": "InstancesRotateServerCertificateRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "acquireSsrsLease": { "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "flatPath": "v1/projects/{project}/instances/{instance}/acquireSsrsLease", @@ -675,6 +742,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "addServerCertificate": { + "description": "Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.", + "flatPath": "v1/projects/{project}/instances/{instance}/addServerCertificate", + "httpMethod": "POST", + "id": "sql.instances.addServerCertificate", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/addServerCertificate", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "clone": { "description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.", "flatPath": "v1/projects/{project}/instances/{instance}/clone", @@ -720,6 +819,28 @@ "instance" ], "parameters": { + "enableFinalBackup": { + "description": "Flag to opt-in for final backup. By default, it is turned off.", + "location": "query", + "type": "boolean" + }, + "finalBackupDescription": { + "description": "Optional. The description of the final backup.", + "location": "query", + "type": "string" + }, + "finalBackupExpiryTime": { + "description": "Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "finalBackupTtlDays": { + "description": "Optional. Retention period of the final backup.", + "format": "int64", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", @@ -1570,6 +1691,11 @@ "project" ], "parameters": { + "filter": { + "description": "Optional. A filter string that follows the rules of EBNF grammar (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Cloud SQL provides filters for status, operationType, and startTime.", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "query", @@ -2267,7 +2393,7 @@ } } }, - "revision": "20240829", + "revision": "20240925", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2457,6 +2583,10 @@ "kind": { "description": "This is always `sql#backupContext`.", "type": "string" + }, + "name": { + "description": "The name of the backup. Format: projects/{project}/backups/{backup}", + "type": "string" } }, "type": "object" @@ -4454,6 +4584,35 @@ }, "type": "object" }, + "InstancesListServerCertificatesResponse": { + "description": "Instances ListServerCertificates response.", + "id": "InstancesListServerCertificatesResponse", + "properties": { + "activeVersion": { + "description": "The `sha1_fingerprint` of the active certificate from `server_certs`.", + "type": "string" + }, + "caCerts": { + "description": "List of server CA certificates for the instance.", + "items": { + "$ref": "SslCert" + }, + "type": "array" + }, + "kind": { + "description": "This is always `sql#instancesListServerCertificates`.", + "type": "string" + }, + "serverCerts": { + "description": "List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.", + "items": { + "$ref": "SslCert" + }, + "type": "array" + } + }, + "type": "object" + }, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -4469,9 +4628,17 @@ "description": "Database instance restore backup request.", "id": "InstancesRestoreBackupRequest", "properties": { + "backup": { + "description": "The name of the backup to restore from in following format: projects/{project-id}/backups/{backup-uid} Only one of restore_backup_context or backup can be passed to the input.", + "type": "string" + }, "restoreBackupContext": { "$ref": "RestoreBackupContext", "description": "Parameters required to perform the restore backup operation." + }, + "restoreInstanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. Restore instance settings overrides the instance settings stored as part of the backup. Instance's major database version cannot be changed and the disk size can only be increased. This feature is only available for restores to new instances using the backup name." } }, "type": "object" @@ -4487,6 +4654,17 @@ }, "type": "object" }, + "InstancesRotateServerCertificateRequest": { + "description": "Rotate server certificate request.", + "id": "InstancesRotateServerCertificateRequest", + "properties": { + "rotateServerCertificateContext": { + "$ref": "RotateServerCertificateContext", + "description": "Optional. Contains details about the rotate server certificate operation." + } + }, + "type": "object" + }, "InstancesTruncateLogRequest": { "description": "Instance truncate log request.", "id": "InstancesTruncateLogRequest", @@ -4859,6 +5037,7 @@ "AUTO_RESTART", "REENCRYPT", "SWITCHOVER", + "UPDATE_BACKUP", "ACQUIRE_SSRS_LEASE", "RELEASE_SSRS_LEASE", "RECONFIGURE_OLD_PRIMARY", @@ -4911,7 +5090,8 @@ false, false, false, - false, + true, + true, false, false ], @@ -4955,6 +5135,7 @@ "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", "Switches the roles of the primary and replica pair. The target instance should be the replica.", + "Update a backup.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", @@ -5107,6 +5288,13 @@ "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" + }, + "warnings": { + "description": "List of warnings that occurred while handling the request.", + "items": { + "$ref": "ApiWarning" + }, + "type": "array" } }, "type": "object" @@ -5314,6 +5502,21 @@ }, "type": "object" }, + "RotateServerCertificateContext": { + "description": "Instance rotate server certificate context.", + "id": "RotateServerCertificateContext", + "properties": { + "kind": { + "description": "Optional. This is always `sql#rotateServerCertificateContext`.", + "type": "string" + }, + "nextVersion": { + "description": "The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", + "type": "string" + } + }, + "type": "object" + }, "Settings": { "description": "Database instance settings.", "id": "Settings", @@ -5642,7 +5845,8 @@ "EXTENSIONS_NOT_ENABLED_IN_REPLICA", "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", - "UNSUPPORTED_SYSTEM_OBJECTS" + "UNSUPPORTED_SYSTEM_OBJECTS", + "UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" ], "enumDescriptions": [ "", @@ -5665,7 +5869,7 @@ "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", "SQL Server Agent is not running.", - "The table definition is not support due to missing primary key or replica identity, applicable for postgres.", + "The table definition is not support due to missing primary key or replica identity, applicable for postgres. Note that this is a warning and won't block the migration.", "The customer has a definer that will break EM setup.", "SQL Server @@SERVERNAME does not match actual host name.", "The primary instance has been setup and will fail the setup.", @@ -5696,7 +5900,8 @@ "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", "The source database has generated columns that can't be migrated. Please change them to regular columns before migration.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", - "The selected objects include system objects that aren't supported for migration." + "The selected objects include system objects that aren't supported for migration.", + "The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." ], "type": "string" } diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 027c9bd4cf..b49cffaae8 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -608,6 +608,73 @@ }, "instances": { "methods": { + "ListServerCertificates": { + "description": "Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out.", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates", + "httpMethod": "GET", + "id": "sql.instances.ListServerCertificates", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates", + "response": { + "$ref": "InstancesListServerCertificatesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "RotateServerCertificate": { + "description": "Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa instead.", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCertificate", + "httpMethod": "POST", + "id": "sql.instances.RotateServerCertificate", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCertificate", + "request": { + "$ref": "InstancesRotateServerCertificateRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "acquireSsrsLease": { "description": "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/acquireSsrsLease", @@ -675,6 +742,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "addServerCertificate": { + "description": "Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa instead.", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCertificate", + "httpMethod": "POST", + "id": "sql.instances.addServerCertificate", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCertificate", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "clone": { "description": "Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/clone", @@ -720,6 +819,28 @@ "instance" ], "parameters": { + "enableFinalBackup": { + "description": "Flag to opt-in for final backup. By default, it is turned off.", + "location": "query", + "type": "boolean" + }, + "finalBackupDescription": { + "description": "Optional. The description of the final backup.", + "location": "query", + "type": "string" + }, + "finalBackupExpiryTime": { + "description": "Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "finalBackupTtlDays": { + "description": "Optional. Retention period of the final backup.", + "format": "int64", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "path", @@ -1570,6 +1691,11 @@ "project" ], "parameters": { + "filter": { + "description": "Optional. A filter string that follows the rules of EBNF grammar (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Cloud SQL provides filters for status, operationType, and startTime.", + "location": "query", + "type": "string" + }, "instance": { "description": "Cloud SQL instance ID. This does not include the project ID.", "location": "query", @@ -2267,7 +2393,7 @@ } } }, - "revision": "20240829", + "revision": "20240925", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2457,6 +2583,10 @@ "kind": { "description": "This is always `sql#backupContext`.", "type": "string" + }, + "name": { + "description": "The name of the backup. Format: projects/{project}/backups/{backup}", + "type": "string" } }, "type": "object" @@ -4455,6 +4585,35 @@ }, "type": "object" }, + "InstancesListServerCertificatesResponse": { + "description": "Instances ListServerCertificatess response.", + "id": "InstancesListServerCertificatesResponse", + "properties": { + "activeVersion": { + "description": "The `sha1_fingerprint` of the active certificate from `server_certs`.", + "type": "string" + }, + "caCerts": { + "description": "List of server CA certificates for the instance.", + "items": { + "$ref": "SslCert" + }, + "type": "array" + }, + "kind": { + "description": "This is always `sql#instancesListServerCertificates`.", + "type": "string" + }, + "serverCerts": { + "description": "List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list.", + "items": { + "$ref": "SslCert" + }, + "type": "array" + } + }, + "type": "object" + }, "InstancesReencryptRequest": { "description": "Database Instance reencrypt request.", "id": "InstancesReencryptRequest", @@ -4470,9 +4629,17 @@ "description": "Database instance restore backup request.", "id": "InstancesRestoreBackupRequest", "properties": { + "backup": { + "description": "The name of the backup to restore from in following format: projects/{project-id}/backups/{backup-uid} Only one of restore_backup_context or backup can be passed to the input.", + "type": "string" + }, "restoreBackupContext": { "$ref": "RestoreBackupContext", "description": "Parameters required to perform the restore backup operation." + }, + "restoreInstanceSettings": { + "$ref": "DatabaseInstance", + "description": "Optional. Restore instance settings overrides the instance settings stored as part of the backup. Instance's major database version cannot be changed and the disk size can only be increased. This feature is only available for restores to new instances using the backup name." } }, "type": "object" @@ -4488,6 +4655,17 @@ }, "type": "object" }, + "InstancesRotateServerCertificateRequest": { + "description": "Rotate Server Certificate request.", + "id": "InstancesRotateServerCertificateRequest", + "properties": { + "rotateServerCertificateContext": { + "$ref": "RotateServerCertificateContext", + "description": "Optional. Contains details about the rotate server CA operation." + } + }, + "type": "object" + }, "InstancesTruncateLogRequest": { "description": "Instance truncate log request.", "id": "InstancesTruncateLogRequest", @@ -4860,6 +5038,7 @@ "AUTO_RESTART", "REENCRYPT", "SWITCHOVER", + "UPDATE_BACKUP", "ACQUIRE_SSRS_LEASE", "RELEASE_SSRS_LEASE", "RECONFIGURE_OLD_PRIMARY", @@ -4912,7 +5091,8 @@ false, false, false, - false, + true, + true, false, false ], @@ -4956,6 +5136,7 @@ "Performs auto-restart of an HA-enabled Cloud SQL database for auto recovery.", "Re-encrypts CMEK instances with latest key version.", "Switches the roles of the primary and replica pair. The target instance should be the replica.", + "Update a backup.", "Acquire a lease for the setup of SQL Server Reporting Services (SSRS).", "Release a lease for the setup of SQL Server Reporting Services (SSRS).", "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", @@ -5108,6 +5289,13 @@ "nextPageToken": { "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", "type": "string" + }, + "warnings": { + "description": "List of warnings that occurred while handling the request.", + "items": { + "$ref": "ApiWarning" + }, + "type": "array" } }, "type": "object" @@ -5315,6 +5503,21 @@ }, "type": "object" }, + "RotateServerCertificateContext": { + "description": "Instance rotate server certificate context.", + "id": "RotateServerCertificateContext", + "properties": { + "kind": { + "description": "Optional. This is always `sql#rotateServerCertificateContext`.", + "type": "string" + }, + "nextVersion": { + "description": "Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version.", + "type": "string" + } + }, + "type": "object" + }, "Settings": { "description": "Database instance settings.", "id": "Settings", @@ -5643,7 +5846,8 @@ "EXTENSIONS_NOT_ENABLED_IN_REPLICA", "UNSUPPORTED_COLUMNS", "USERS_NOT_CREATED_IN_REPLICA", - "UNSUPPORTED_SYSTEM_OBJECTS" + "UNSUPPORTED_SYSTEM_OBJECTS", + "UNSUPPORTED_TABLES_WITH_REPLICA_IDENTITY" ], "enumDescriptions": [ "", @@ -5666,7 +5870,7 @@ "The primary instance database parameter setup doesn't allow EM sync.", "The gtid_mode is not supported, applicable for MySQL.", "SQL Server Agent is not running.", - "The table definition is not support due to missing primary key or replica identity, applicable for postgres.", + "The table definition is not support due to missing primary key or replica identity, applicable for postgres. Note that this is a warning and won't block the migration.", "The customer has a definer that will break EM setup.", "SQL Server @@SERVERNAME does not match actual host name.", "The primary instance has been setup and will fail the setup.", @@ -5697,7 +5901,8 @@ "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", "The source database has generated columns that can't be migrated. Please change them to regular columns before migration.", "The source database has users that aren't created in the replica. First, create all users, which are in the pg_user_mappings table of the source database, in the destination instance. Then, perform the migration.", - "The selected objects include system objects that aren't supported for migration." + "The selected objects include system objects that aren't supported for migration.", + "The source database has tables with the FULL or NOTHING replica identity. Before starting your migration, either remove the identity or change it to DEFAULT. Note that this is an error and will block the migration." ], "type": "string" } diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 4c2877c302..d23f5aee9b 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -32,6 +32,11 @@ "endpointUrl": "https://storage.europe-west3.rep.googleapis.com/", "location": "europe-west3" }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, { "description": "Regional Endpoint", "endpointUrl": "https://storage.europe-west9.rep.googleapis.com/", @@ -41,9 +46,54 @@ "description": "Regional Endpoint", "endpointUrl": "https://storage.me-central2.rep.googleapis.com/", "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://storage.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], - "etag": "\"38363036373236373330353534313035333932\"", + "etag": "\"3133363239393031373133303332303839383336\"", "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" @@ -1029,6 +1079,34 @@ "https://www.googleapis.com/auth/devstorage.full_control" ] }, + "relocate": { + "description": "Initiates a long-running Relocate Bucket operation on the specified bucket.", + "httpMethod": "POST", + "id": "storage.buckets.relocate", + "parameterOrder": [ + "bucket" + ], + "parameters": { + "bucket": { + "description": "Name of the bucket to be moved.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "b/{bucket}/relocate", + "request": { + "$ref": "RelocateBucketRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, "restore": { "description": "Restores a soft-deleted bucket.", "httpMethod": "POST", @@ -2829,6 +2907,11 @@ "location": "query", "type": "string" }, + "restoreToken": { + "description": "Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.", + "location": "query", + "type": "string" + }, "softDeleted": { "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", "location": "query", @@ -3304,6 +3387,11 @@ "location": "query", "type": "string" }, + "restoreToken": { + "description": "Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation.", + "location": "query", + "type": "string" + }, "userProject": { "description": "The project to be billed for this request. Required for Requester Pays buckets.", "location": "query", @@ -4136,7 +4224,7 @@ } } }, - "revision": "20240819", + "revision": "20240924", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { @@ -5597,6 +5685,10 @@ }, "type": "object" }, + "restoreToken": { + "description": "Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets.", + "type": "string" + }, "retention": { "description": "A collection of object level retention parameters.", "properties": { @@ -5865,6 +5957,34 @@ }, "type": "object" }, + "RelocateBucketRequest": { + "description": "A Relocate Bucket request.", + "id": "RelocateBucketRequest", + "properties": { + "destinationCustomPlacementConfig": { + "description": "The bucket's new custom placement configuration if relocating to a Custom Dual Region.", + "properties": { + "dataLocations": { + "description": "The list of regional locations in which data is placed.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "destinationLocation": { + "description": "The new location the bucket will be relocated to.", + "type": "string" + }, + "validateOnly": { + "description": "If true, validate the operation, but do not actually relocate the bucket.", + "type": "boolean" + } + }, + "type": "object" + }, "RewriteResponse": { "description": "A rewrite response.", "id": "RewriteResponse", diff --git a/discovery/storagetransfer-v1.json b/discovery/storagetransfer-v1.json index 08aad03791..fddfc9601a 100644 --- a/discovery/storagetransfer-v1.json +++ b/discovery/storagetransfer-v1.json @@ -392,7 +392,7 @@ ], "parameters": { "filter": { - "description": "Required. A list of query parameters specified as JSON text in the form of: `{\"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"jobStatuses\":[\"status1\",\"status2\",...]}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED.", + "description": "Required. A list of query parameters specified as JSON text in the form of: ``` { \"projectId\":\"my_project_id\", \"jobNames\":[\"jobid1\",\"jobid2\",...], \"jobStatuses\":[\"status1\",\"status2\",...], \"dataBackend\":\"QUERY_REPLICATION_CONFIGS\", \"sourceBucket\":\"source-bucket-name\", \"sinkBucket\":\"sink-bucket-name\", } ``` The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks. * `projectId` is required. * Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `jobNames` and `jobStatuses` are optional. Valid values are case-insensitive: * ENABLED * DISABLED * DELETED * Specify `\"dataBackend\":\"QUERY_REPLICATION_CONFIGS\"` to return a list of cross-bucket replication jobs. * Limit the results to jobs from a particular bucket with `sourceBucket` and/or to a particular bucket with `sinkBucket`.", "location": "query", "required": true, "type": "string" @@ -632,7 +632,7 @@ } } }, - "revision": "20240622", + "revision": "20240928", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { @@ -1368,24 +1368,24 @@ "type": "object" }, "ReplicationSpec": { - "description": "Specifies the configuration for running a replication job.", + "description": "Specifies the configuration for a cross-bucket replication job. Cross-bucket replication copies new or updated objects from a source Cloud Storage bucket to a destination Cloud Storage bucket. Existing objects in the source bucket are not copied by a new cross-bucket replication job.", "id": "ReplicationSpec", "properties": { "gcsDataSink": { "$ref": "GcsData", - "description": "Specifies cloud Storage data sink." + "description": "The Cloud Storage bucket to which to replicate objects." }, "gcsDataSource": { "$ref": "GcsData", - "description": "Specifies cloud Storage data source." + "description": "The Cloud Storage bucket from which to replicate objects." }, "objectConditions": { "$ref": "ObjectConditions", - "description": "Specifies the object conditions to only include objects that satisfy these conditions in the set of data source objects. Object conditions based on objects' \"last modification time\" do not exclude objects in a data sink." + "description": "Object conditions that determine which objects are transferred. For replication jobs, only `include_prefixes` and `exclude_prefixes` are supported." }, "transferOptions": { "$ref": "TransferOptions", - "description": "Specifies the actions to be performed on the object during replication. Delete options are not supported for replication and when specified, the request fails with an INVALID_ARGUMENT error." + "description": "Specifies the metadata options to be applied during replication. Delete options are not supported. If a delete option is specified, the request fails with an INVALID_ARGUMENT error." } }, "type": "object" diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index 3c7a8f826f..96d77a7d98 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20240704", + "revision": "20240904", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -194,7 +194,7 @@ "type": "string" }, "requestedTokenType": { - "description": "Required. An identifier for the type of requested security token. Can be `urn:ietf:params:oauth:token-type:access_token` or `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", + "description": "Required. An identifier for the type of requested security token. Can be `urn:ietf:params:oauth:token-type:access_token` or `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`.", "type": "string" }, "scope": { @@ -217,7 +217,7 @@ "id": "GoogleIdentityStsV1ExchangeTokenResponse", "properties": { "access_boundary_session_key": { - "description": "The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", + "description": "The access boundary session key. This key is used along with the access boundary intermediary token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`.", "format": "byte", "type": "string" }, diff --git a/discovery/testing-v1.json b/discovery/testing-v1.json index 12bd845791..5a5ac61cb4 100644 --- a/discovery/testing-v1.json +++ b/discovery/testing-v1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20240319", + "revision": "20240917", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { @@ -664,6 +664,11 @@ "description": "The unique opaque id for this model. Use this for invoking the TestExecutionService.", "type": "string" }, + "labInfo": { + "$ref": "LabInfo", + "description": "Output only. Lab info of this device.", + "readOnly": true + }, "lowFpsVideoRecording": { "description": "True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config.", "type": "boolean" @@ -1705,6 +1710,17 @@ }, "type": "object" }, + "LabInfo": { + "description": "Lab specific information for a device.", + "id": "LabInfo", + "properties": { + "name": { + "description": "Lab name where the device is hosted. If empty, the device is hosted in a Google owned lab.", + "type": "string" + } + }, + "type": "object" + }, "LauncherActivityIntent": { "description": "Specifies an intent that starts the main launcher activity.", "id": "LauncherActivityIntent", diff --git a/discovery/texttospeech-v1.json b/discovery/texttospeech-v1.json index 97cd64553d..4760146532 100644 --- a/discovery/texttospeech-v1.json +++ b/discovery/texttospeech-v1.json @@ -294,6 +294,24 @@ }, "voices": { "methods": { + "generateVoiceCloningKey": { + "description": "Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.", + "flatPath": "v1/voices:generateVoiceCloningKey", + "httpMethod": "POST", + "id": "texttospeech.voices.generateVoiceCloningKey", + "parameterOrder": [], + "parameters": {}, + "path": "v1/voices:generateVoiceCloningKey", + "request": { + "$ref": "GenerateVoiceCloningKeyRequest" + }, + "response": { + "$ref": "GenerateVoiceCloningKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Returns a list of Voice supported for synthesis.", "flatPath": "v1/voices", @@ -318,9 +336,20 @@ } } }, - "revision": "20240815", + "revision": "20241001", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { + "AdvancedVoiceOptions": { + "description": "Used for advanced voice options.", + "id": "AdvancedVoiceOptions", + "properties": { + "lowLatencyJourneySynthesis": { + "description": "Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency.", + "type": "boolean" + } + }, + "type": "object" + }, "AudioConfig": { "description": "Description of audio data to be synthesized.", "id": "AudioConfig", @@ -381,6 +410,49 @@ "properties": {}, "type": "object" }, + "CustomPronunciationParams": { + "description": "Pronunciation customization for a phrase.", + "id": "CustomPronunciationParams", + "properties": { + "phoneticEncoding": { + "description": "The phonetic encoding of the phrase.", + "enum": [ + "PHONETIC_ENCODING_UNSPECIFIED", + "PHONETIC_ENCODING_IPA", + "PHONETIC_ENCODING_X_SAMPA" + ], + "enumDescriptions": [ + "Not specified.", + "IPA. (e.g. apple -> ˈæpəl ) https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", + "X-SAMPA (e.g. apple -> \"{p@l\" ) https://en.wikipedia.org/wiki/X-SAMPA" + ], + "type": "string" + }, + "phrase": { + "description": "The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.", + "type": "string" + }, + "pronunciation": { + "description": "The pronunciation of the phrase. This must be in the phonetic encoding specified above.", + "type": "string" + } + }, + "type": "object" + }, + "CustomPronunciations": { + "description": "A collection of pronunciation customizations.", + "id": "CustomPronunciations", + "properties": { + "pronunciations": { + "description": "The pronunciation customizations to be applied.", + "items": { + "$ref": "CustomPronunciationParams" + }, + "type": "array" + } + }, + "type": "object" + }, "CustomVoiceParams": { "description": "Description of the custom voice to be synthesized.", "id": "CustomVoiceParams", @@ -413,6 +485,40 @@ "properties": {}, "type": "object" }, + "GenerateVoiceCloningKeyRequest": { + "description": "Request message for the `GenerateVoiceCloningKey` method.", + "id": "GenerateVoiceCloningKeyRequest", + "properties": { + "consentScript": { + "description": "Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.", + "type": "string" + }, + "languageCode": { + "description": "Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.", + "type": "string" + }, + "referenceAudio": { + "$ref": "InputAudio", + "description": "Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected." + }, + "voiceTalentConsent": { + "$ref": "InputAudio", + "description": "Required. The voice talent audio used to verify consent to voice clone." + } + }, + "type": "object" + }, + "GenerateVoiceCloningKeyResponse": { + "description": "Response message for the `GenerateVoiceCloningKey` method.", + "id": "GenerateVoiceCloningKeyResponse", + "properties": { + "voiceCloningKey": { + "description": "The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata": { "description": "Metadata for response returned by the `SynthesizeLongAudio` method.", "id": "GoogleCloudTexttospeechV1SynthesizeLongAudioMetadata", @@ -436,6 +542,54 @@ }, "type": "object" }, + "InputAudio": { + "description": "Holds audio content and config.", + "id": "InputAudio", + "properties": { + "audioConfig": { + "$ref": "InputAudioConfig", + "description": "Required. Provides information that specifies how to process content." + }, + "content": { + "description": "Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "InputAudioConfig": { + "description": "Description of inputted audio data.", + "id": "InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. The format of the audio byte stream.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "LINEAR16", + "MP3", + "OGG_OPUS", + "MULAW", + "ALAW" + ], + "enumDescriptions": [ + "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Audio content returned as MULAW also contains a WAV header.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header." + ], + "type": "string" + }, + "sampleRateHertz": { + "description": "Required. The sample rate (in hertz) for this audio.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -534,6 +688,10 @@ "description": "Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.", "id": "SynthesisInput", "properties": { + "customPronunciations": { + "$ref": "CustomPronunciations", + "description": "Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. 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 (entirely or partially)." + }, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -595,6 +753,10 @@ "description": "The top-level message sent by the client for the `SynthesizeSpeech` method.", "id": "SynthesizeSpeechRequest", "properties": { + "advancedVoiceOptions": { + "$ref": "AdvancedVoiceOptions", + "description": "Adnanced voice options." + }, "audioConfig": { "$ref": "AudioConfig", "description": "Required. The configuration of the synthesized audio." @@ -661,6 +823,17 @@ }, "type": "object" }, + "VoiceCloneParams": { + "description": "The configuration of Voice Clone feature.", + "id": "VoiceCloneParams", + "properties": { + "voiceCloningKey": { + "description": "Required. Created by GenerateVoiceCloningKey.", + "type": "string" + } + }, + "type": "object" + }, "VoiceSelectionParams": { "description": "Description of which voice to use for a synthesis request.", "id": "VoiceSelectionParams", @@ -692,6 +865,10 @@ "A gender-neutral voice. This voice is not yet supported." ], "type": "string" + }, + "voiceClone": { + "$ref": "VoiceCloneParams", + "description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration." } }, "type": "object" diff --git a/discovery/texttospeech-v1beta1.json b/discovery/texttospeech-v1beta1.json index c70b2d806b..2b3e115b62 100644 --- a/discovery/texttospeech-v1beta1.json +++ b/discovery/texttospeech-v1beta1.json @@ -237,6 +237,24 @@ }, "voices": { "methods": { + "generateVoiceCloningKey": { + "description": "Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.", + "flatPath": "v1beta1/voices:generateVoiceCloningKey", + "httpMethod": "POST", + "id": "texttospeech.voices.generateVoiceCloningKey", + "parameterOrder": [], + "parameters": {}, + "path": "v1beta1/voices:generateVoiceCloningKey", + "request": { + "$ref": "GenerateVoiceCloningKeyRequest" + }, + "response": { + "$ref": "GenerateVoiceCloningKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Returns a list of Voice supported for synthesis.", "flatPath": "v1beta1/voices", @@ -261,9 +279,20 @@ } } }, - "revision": "20240815", + "revision": "20241001", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { + "AdvancedVoiceOptions": { + "description": "Used for advanced voice options.", + "id": "AdvancedVoiceOptions", + "properties": { + "lowLatencyJourneySynthesis": { + "description": "Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency.", + "type": "boolean" + } + }, + "type": "object" + }, "AudioConfig": { "description": "Description of audio data to be synthesized.", "id": "AudioConfig", @@ -320,6 +349,49 @@ }, "type": "object" }, + "CustomPronunciationParams": { + "description": "Pronunciation customization for a phrase.", + "id": "CustomPronunciationParams", + "properties": { + "phoneticEncoding": { + "description": "The phonetic encoding of the phrase.", + "enum": [ + "PHONETIC_ENCODING_UNSPECIFIED", + "PHONETIC_ENCODING_IPA", + "PHONETIC_ENCODING_X_SAMPA" + ], + "enumDescriptions": [ + "Not specified.", + "IPA. (e.g. apple -> ˈæpəl ) https://en.wikipedia.org/wiki/International_Phonetic_Alphabet", + "X-SAMPA (e.g. apple -> \"{p@l\" ) https://en.wikipedia.org/wiki/X-SAMPA" + ], + "type": "string" + }, + "phrase": { + "description": "The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence.", + "type": "string" + }, + "pronunciation": { + "description": "The pronunciation of the phrase. This must be in the phonetic encoding specified above.", + "type": "string" + } + }, + "type": "object" + }, + "CustomPronunciations": { + "description": "A collection of pronunciation customizations.", + "id": "CustomPronunciations", + "properties": { + "pronunciations": { + "description": "The pronunciation customizations to be applied.", + "items": { + "$ref": "CustomPronunciationParams" + }, + "type": "array" + } + }, + "type": "object" + }, "CustomVoiceParams": { "description": "Description of the custom voice to be synthesized.", "id": "CustomVoiceParams", @@ -346,6 +418,40 @@ }, "type": "object" }, + "GenerateVoiceCloningKeyRequest": { + "description": "Request message for the `GenerateVoiceCloningKey` method.", + "id": "GenerateVoiceCloningKeyRequest", + "properties": { + "consentScript": { + "description": "Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.", + "type": "string" + }, + "languageCode": { + "description": "Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: \"en-US\". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.", + "type": "string" + }, + "referenceAudio": { + "$ref": "InputAudio", + "description": "Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected." + }, + "voiceTalentConsent": { + "$ref": "InputAudio", + "description": "Required. The voice talent audio used to verify consent to voice clone." + } + }, + "type": "object" + }, + "GenerateVoiceCloningKeyResponse": { + "description": "Response message for the `GenerateVoiceCloningKey` method.", + "id": "GenerateVoiceCloningKeyResponse", + "properties": { + "voiceCloningKey": { + "description": "The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudTexttospeechV1beta1SynthesizeLongAudioMetadata": { "description": "Metadata for response returned by the `SynthesizeLongAudio` method.", "id": "GoogleCloudTexttospeechV1beta1SynthesizeLongAudioMetadata", @@ -369,6 +475,56 @@ }, "type": "object" }, + "InputAudio": { + "description": "Holds audio content and config.", + "id": "InputAudio", + "properties": { + "audioConfig": { + "$ref": "InputAudioConfig", + "description": "Required. Provides information that specifies how to process content." + }, + "content": { + "description": "Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "InputAudioConfig": { + "description": "Description of inputted audio data.", + "id": "InputAudioConfig", + "properties": { + "audioEncoding": { + "description": "Required. The format of the audio byte stream.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "LINEAR16", + "MP3", + "MP3_64_KBPS", + "OGG_OPUS", + "MULAW", + "ALAW" + ], + "enumDescriptions": [ + "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM). Audio content returned as LINEAR16 also contains a WAV header.", + "MP3 audio at 32kbps.", + "MP3 at 64kbps.", + "Opus encoded audio wrapped in an ogg container. The result will be a file which can be played natively on Android, and in browsers (at least Chrome and Firefox). The quality of the encoding is considerably higher than MP3 while using approximately the same bitrate.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law. Audio content returned as MULAW also contains a WAV header.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/A-law. Audio content returned as ALAW also contains a WAV header." + ], + "type": "string" + }, + "sampleRateHertz": { + "description": "Required. The sample rate (in hertz) for this audio.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -467,6 +623,10 @@ "description": "Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes.", "id": "SynthesisInput", "properties": { + "customPronunciations": { + "$ref": "CustomPronunciations", + "description": "Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. 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 (entirely or partially)." + }, "ssml": { "description": "The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).", "type": "string" @@ -528,6 +688,10 @@ "description": "The top-level message sent by the client for the `SynthesizeSpeech` method.", "id": "SynthesizeSpeechRequest", "properties": { + "advancedVoiceOptions": { + "$ref": "AdvancedVoiceOptions", + "description": "Adnanced voice options." + }, "audioConfig": { "$ref": "AudioConfig", "description": "Required. The configuration of the synthesized audio." @@ -636,6 +800,17 @@ }, "type": "object" }, + "VoiceCloneParams": { + "description": "The configuration of Voice Clone feature.", + "id": "VoiceCloneParams", + "properties": { + "voiceCloningKey": { + "description": "Required. Created by GenerateVoiceCloningKey.", + "type": "string" + } + }, + "type": "object" + }, "VoiceSelectionParams": { "description": "Description of which voice to use for a synthesis request.", "id": "VoiceSelectionParams", @@ -667,6 +842,10 @@ "A gender-neutral voice. This voice is not yet supported." ], "type": "string" + }, + "voiceClone": { + "$ref": "VoiceCloneParams", + "description": "Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration." } }, "type": "object" diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index 09bf478eed..8615ae6957 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20240613", + "revision": "20240916", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1628,6 +1628,13 @@ "$ref": "NetworkConfig", "description": "Network configurations for the TPU node." }, + "networkConfigs": { + "description": "Optional. Repeated network configurations for the TPU node.", + "items": { + "$ref": "NetworkConfig" + }, + "type": "array" + }, "networkEndpoints": { "description": "Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first.", "items": { diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index a1b09b33d9..95e6cdfd92 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -1132,7 +1132,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-translation" ] }, "delete": { @@ -1707,7 +1708,7 @@ } } }, - "revision": "20240821", + "revision": "20240912", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { diff --git a/discovery/vision-v1.json b/discovery/vision-v1.json index 681a844bfc..3aa95ebabc 100644 --- a/discovery/vision-v1.json +++ b/discovery/vision-v1.json @@ -1282,7 +1282,7 @@ } } }, - "revision": "20231219", + "revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { @@ -2748,7 +2748,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4162,7 +4162,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -5611,7 +5611,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7154,7 +7154,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -8322,7 +8322,7 @@ "type": "object" }, "Landmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/discovery/vision-v1p1beta1.json b/discovery/vision-v1p1beta1.json index f239a6cbdf..49035584f0 100644 --- a/discovery/vision-v1p1beta1.json +++ b/discovery/vision-v1p1beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20231219", + "revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -1856,7 +1856,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -3456,7 +3456,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4905,7 +4905,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -6448,7 +6448,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7518,7 +7518,7 @@ "type": "object" }, "Landmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/discovery/vision-v1p2beta1.json b/discovery/vision-v1p2beta1.json index bd5f647c5f..481956fa08 100644 --- a/discovery/vision-v1p2beta1.json +++ b/discovery/vision-v1p2beta1.json @@ -449,7 +449,7 @@ } } }, - "revision": "20231219", + "revision": "20240823", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AnnotateFileResponse": { @@ -1631,7 +1631,7 @@ "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "properties": { "position": { @@ -3270,7 +3270,7 @@ "type": "object" }, "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p2beta1FaceAnnotationLandmark", "properties": { "position": { @@ -4905,7 +4905,7 @@ "type": "object" }, "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p3beta1FaceAnnotationLandmark", "properties": { "position": { @@ -6448,7 +6448,7 @@ "type": "object" }, "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "GoogleCloudVisionV1p4beta1FaceAnnotationLandmark", "properties": { "position": { @@ -7518,7 +7518,7 @@ "type": "object" }, "Landmark": { - "description": "A face-specific landmark (for example, a face feature).", + "description": "A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`.", "id": "Landmark", "properties": { "position": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index 83dd48ac7d..b6ff7db6af 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -520,12 +520,12 @@ ], "parameters": { "filter": { - "description": "Optional. The filter request (according to https://google.aip.dev/160).", + "description": "Optional. The filter request (according to AIP-160).", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by \"name\" field.", + "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field.", "location": "query", "type": "string" }, @@ -623,12 +623,12 @@ ], "parameters": { "filter": { - "description": "Optional. The filter request (according to https://google.aip.dev/160).", + "description": "Optional. The filter request (according to AIP-160).", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by \"name\" field.", + "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field.", "location": "query", "type": "string" }, @@ -2220,7 +2220,7 @@ } } }, - "revision": "20240822", + "revision": "20240912", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index 61739e36eb..0614fc4da7 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -520,12 +520,12 @@ ], "parameters": { "filter": { - "description": "Optional. The filter request (according to https://google.aip.dev/160).", + "description": "Optional. The filter request (according to AIP-160).", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by \"name\" field.", + "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field.", "location": "query", "type": "string" }, @@ -623,12 +623,12 @@ ], "parameters": { "filter": { - "description": "Optional. The filter request (according to https://google.aip.dev/160).", + "description": "Optional. The filter request (according to AIP-160).", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by \"name\" field.", + "description": "Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by \"name\" field.", "location": "query", "type": "string" }, @@ -2220,7 +2220,7 @@ } } }, - "revision": "20240822", + "revision": "20240912", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { diff --git a/discovery/vpcaccess-v1.json b/discovery/vpcaccess-v1.json index 235dcce6cc..041aaa4484 100644 --- a/discovery/vpcaccess-v1.json +++ b/discovery/vpcaccess-v1.json @@ -384,7 +384,7 @@ } } }, - "revision": "20231214", + "revision": "20240905", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -400,7 +400,7 @@ "type": "array" }, "ipCidrRange": { - "description": "The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.", + "description": "Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.", "type": "string" }, "machineType": { @@ -413,6 +413,7 @@ "type": "integer" }, "maxThroughput": { + "deprecated": true, "description": "Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.", "format": "int32", "type": "integer" @@ -423,6 +424,7 @@ "type": "integer" }, "minThroughput": { + "deprecated": true, "description": "Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.", "format": "int32", "type": "integer" @@ -432,7 +434,7 @@ "type": "string" }, "network": { - "description": "Name of a VPC network.", + "description": "Optional. Name of a VPC network.", "type": "string" }, "state": { @@ -458,7 +460,7 @@ }, "subnet": { "$ref": "Subnet", - "description": "The subnet in which to house the VPC Access Connector." + "description": "Optional. The subnet in which to house the VPC Access Connector." } }, "type": "object" @@ -705,11 +707,11 @@ "id": "Subnet", "properties": { "name": { - "description": "Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}", + "description": "Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}", "type": "string" }, "projectId": { - "description": "Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.", + "description": "Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.", "type": "string" } }, diff --git a/discovery/vpcaccess-v1beta1.json b/discovery/vpcaccess-v1beta1.json index 59c73398be..257ea036fc 100644 --- a/discovery/vpcaccess-v1beta1.json +++ b/discovery/vpcaccess-v1beta1.json @@ -384,7 +384,7 @@ } } }, - "revision": "20231214", + "revision": "20240905", "rootUrl": "https://vpcaccess.googleapis.com/", "schemas": { "Connector": { @@ -406,7 +406,7 @@ "type": "string" }, "ipCidrRange": { - "description": "The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.", + "description": "Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`.", "type": "string" }, "lastRestartTime": { @@ -425,6 +425,7 @@ "type": "integer" }, "maxThroughput": { + "deprecated": true, "description": "Maximum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 300 through 1000. Must be higher than the value specified by --min-throughput. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. The use of `max-throughput` is discouraged in favor of `max-instances`.", "format": "int32", "type": "integer" @@ -435,6 +436,7 @@ "type": "integer" }, "minThroughput": { + "deprecated": true, "description": "Minimum throughput of the connector in Mbps. Refers to the expected throughput when using an `e2-micro` machine type. Value must be a multiple of 100 from 200 through 900. Must be lower than the value specified by --max-throughput. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. The use of `min-throughput` is discouraged in favor of `min-instances`.", "format": "int32", "type": "integer" @@ -444,7 +446,7 @@ "type": "string" }, "network": { - "description": "Name of a VPC network.", + "description": "Optional. Name of a VPC network.", "type": "string" }, "state": { @@ -470,7 +472,7 @@ }, "subnet": { "$ref": "Subnet", - "description": "The subnet in which to house the VPC Access Connector." + "description": "Optional. The subnet in which to house the VPC Access Connector." } }, "type": "object" @@ -717,11 +719,11 @@ "id": "Subnet", "properties": { "name": { - "description": "Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}", + "description": "Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetName} the correct input for this field would be {subnetName}", "type": "string" }, "projectId": { - "description": "Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.", + "description": "Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued.", "type": "string" } }, diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index 4f8ffd3424..b64a2680df 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2681,7 +2681,7 @@ } } }, - "revision": "20240809", + "revision": "20240927", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3906,6 +3906,7 @@ "description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -4077,6 +4078,13 @@ }, "type": "array" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "venue": { "$ref": "EventVenue", "description": "Event venue details." @@ -4226,6 +4234,7 @@ "description": "Links module data. If links module data is also defined on the class, both will be displayed." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -4323,6 +4332,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -4701,6 +4717,7 @@ "description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -4809,6 +4826,13 @@ }, "type": "array" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -4974,6 +4998,7 @@ "description": "Links module data. If links module data is also defined on the class, both will be displayed." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -5063,6 +5088,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -5210,6 +5242,13 @@ }, "type": "array" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "viewUnlockRequirement": { "description": "View Unlock Requirement options for the generic pass.", "enum": [ @@ -5435,6 +5474,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "wideLogo": { "$ref": "Image", "description": "The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view." @@ -5573,6 +5619,7 @@ "description": "Translated strings for the pin_label." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -5689,6 +5736,13 @@ }, "type": "array" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -5835,6 +5889,7 @@ "description": "Links module data. If links module data is also defined on the class, both will be displayed." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -5916,6 +5971,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -6397,6 +6459,7 @@ "description": "Translated strings for the secondary_rewards_tier_label." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -6525,6 +6588,13 @@ }, "type": "array" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -6670,6 +6740,7 @@ "description": "Links module data. If links module data is also defined on the class, both will be displayed." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -6755,6 +6826,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -7163,6 +7241,17 @@ }, "type": "object" }, + "ModuleViewConstraints": { + "description": "Constraints that all must be met for the module to be shown.", + "id": "ModuleViewConstraints", + "properties": { + "displayInterval": { + "$ref": "TimeInterval", + "description": "The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set." + } + }, + "type": "object" + }, "Money": { "id": "Money", "properties": { @@ -7324,6 +7413,7 @@ "description": "Translated strings for the title. Recommended maximum length is 60 characters to ensure full string is displayed on smaller screens." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -7481,6 +7571,13 @@ "$ref": "Image", "description": "The title image of the offer. This image is displayed in both the details and list views of the app." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -7688,6 +7785,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -8696,6 +8800,7 @@ "description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -8851,6 +8956,13 @@ ], "type": "string" }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -9031,6 +9143,7 @@ "description": "Links module data. If links module data is also defined on the class, both will be displayed." }, "locations": { + "deprecated": true, "description": "Note: This field is currently not supported to trigger geo notifications.", "items": { "$ref": "LatLongPoint" @@ -9220,6 +9333,13 @@ "$ref": "TimeInterval", "description": "The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed." }, + "valueAddedModuleData": { + "description": "Optional value added module data. Maximum of ten on the object.", + "items": { + "$ref": "ValueAddedModuleData" + }, + "type": "array" + }, "version": { "deprecated": true, "description": "Deprecated", @@ -9333,6 +9453,38 @@ } }, "type": "object" + }, + "ValueAddedModuleData": { + "description": "Data for Value Added module. Required fields are header and uri.", + "id": "ValueAddedModuleData", + "properties": { + "body": { + "$ref": "LocalizedString", + "description": "Body to be displayed on the module. Character limit is 50 and longer strings will be truncated." + }, + "header": { + "$ref": "LocalizedString", + "description": "Header to be displayed on the module. Character limit is 60 and longer strings will be truncated." + }, + "image": { + "$ref": "Image", + "description": "Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio." + }, + "sortIndex": { + "description": "The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking.", + "type": "string" + }, + "viewConstraints": { + "$ref": "ModuleViewConstraints", + "description": "Constraints that all must be met for the module to be shown." + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/workflowexecutions-v1.json b/discovery/workflowexecutions-v1.json index 0c8a5e9aa0..b0450bc486 100644 --- a/discovery/workflowexecutions-v1.json +++ b/discovery/workflowexecutions-v1.json @@ -302,7 +302,7 @@ ], "parameters": { "filter": { - "description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", + "description": "Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, `label`, and `disableConcurrencyQuotaOverflowBuffering`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state=\"SUCCEEDED\"` or `startTime>\"2023-08-01\" AND state=\"FAILED\"`", "location": "query", "type": "string" }, @@ -517,7 +517,7 @@ } } }, - "revision": "20240813", + "revision": "20240916", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -682,7 +682,7 @@ "type": "string" }, "startTime": { - "description": "Output only. Marks the beginning of execution.", + "description": "Output only. Marks the beginning of execution. Note that this will be the same as `createTime` for executions that start immediately.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1009,13 +1009,15 @@ "STATE_UNSPECIFIED", "STATE_IN_PROGRESS", "STATE_SUCCEEDED", - "STATE_FAILED" + "STATE_FAILED", + "STATE_CANCELLED" ], "enumDescriptions": [ "Invalid state.", "The step entry is in progress.", "The step entry finished successfully.", - "The step entry failed with an error." + "The step entry failed with an error.", + "The step entry is cancelled." ], "readOnly": true, "type": "string" diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index dd3cfdfc1e..bbb1bb8204 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-v1.json @@ -485,7 +485,7 @@ } } }, - "revision": "20240814", + "revision": "20240925", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -722,7 +722,7 @@ "type": "object" }, "Workflow": { - "description": "LINT.IfChange Workflow program to be executed by Workflows.", + "description": "Workflow program to be executed by Workflows.", "id": "Workflow", "properties": { "allKmsKeys": { diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index f0a532d9f2..2b245913b6 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,7 +1195,7 @@ } } }, - "revision": "20240820", + "revision": "20240904", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2356,7 +2356,7 @@ "type": "string" }, "enableAuditAgent": { - "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", + "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { @@ -2395,7 +2395,7 @@ "type": "object" }, "maxUsableWorkstations": { - "description": "Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited.", + "description": "Optional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited.", "format": "int32", "type": "integer" }, diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 04deeaf7bf..da19146f3e 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240820", + "revision": "20240904", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1237,7 +1237,7 @@ "type": "boolean" }, "id": { - "description": "Optional. Required. The id to be used for the boost config.", + "description": "Optional. Required. The id to be used for the boost configuration.", "type": "string" }, "machineType": { @@ -2052,7 +2052,7 @@ "type": "object" }, "boostConfigs": { - "description": "Output only. List of available boost configuration ids that this workstation can be boosted up to", + "description": "Output only. List of available boost configuration IDs that this workstation can be boosted up to.", "items": { "$ref": "WorkstationBoostConfig" }, @@ -2166,11 +2166,11 @@ "type": "object" }, "WorkstationBoostConfig": { - "description": "Boost config for this workstation. This object is populated from the parent workstation config.", + "description": "Boost configuration for this workstation. This object is populated from the parent workstation configuration.", "id": "WorkstationBoostConfig", "properties": { "id": { - "description": "Output only. Boost config id.", + "description": "Output only. Boost configuration ID.", "readOnly": true, "type": "string" } @@ -2338,7 +2338,7 @@ "type": "string" }, "enableAuditAgent": { - "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", + "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { @@ -2381,7 +2381,7 @@ "type": "object" }, "maxUsableWorkstations": { - "description": "Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited.", + "description": "Optional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited.", "format": "int32", "type": "integer" }, diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index 8e70ea1113..ac111201fa 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -4072,7 +4072,7 @@ } } }, - "revision": "20240814", + "revision": "20240926", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -10573,10 +10573,6 @@ "description": "The ID that YouTube uses to uniquely identify the subscriber's channel.", "type": "string" }, - "channelTitle": { - "description": "Channel title for the channel that the subscription belongs to.", - "type": "string" - }, "description": { "description": "The subscription's details.", "type": "string" @@ -11016,6 +11012,9 @@ "$ref": "VideoMonetizationDetails", "description": "The monetizationDetails object encapsulates information about the monetization status of the video." }, + "paidProductPlacementDetails": { + "$ref": "VideoPaidProductPlacementDetails" + }, "player": { "$ref": "VideoPlayer", "description": "The player object contains information that you would use to play the video in an embedded player." @@ -11678,6 +11677,17 @@ }, "type": "object" }, + "VideoPaidProductPlacementDetails": { + "description": "Details about paid content, such as paid product placement, sponsorships or endorsement, contained in a YouTube video and a method to inform viewers of paid promotion. This data can only be retrieved by the video owner.", + "id": "VideoPaidProductPlacementDetails", + "properties": { + "hasPaidProductPlacement": { + "description": "This boolean represents whether the video contains Paid Product Placement, Studio equivalent: https://screenshot.googleplex.com/4Me79DE6AfT2ktp.png", + "type": "boolean" + } + }, + "type": "object" + }, "VideoPlayer": { "description": "Player to be used for a video playback.", "id": "VideoPlayer", @@ -11939,7 +11949,7 @@ "type": "object" }, "VideoStatus": { - "description": "Basic details about a video category, such as its localized title. Next Id: 18", + "description": "Basic details about a video category, such as its localized title. Next Id: 19", "id": "VideoStatus", "properties": { "embeddable": { diff --git a/release-please-config.json b/release-please-config.json index 14241fec14..b1f0ddae79 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -302,6 +302,8 @@ "src/apis/apim": {}, "src/apis/adsenseplatform": {}, "src/apis/keep": {}, - "src/apis/css": {} + "src/apis/css": {}, + "src/apis/oracledatabase": {}, + "src/apis/firebasedataconnect": {} } } \ No newline at end of file diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 13989311aa..2614c5e1b1 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -184,6 +184,28 @@ export namespace accesscontextmanager_v1 { */ title?: string | null; } + /** + * Access scope represents the client scope, etc. to which the settings will be applied to. + */ + export interface Schema$AccessScope { + /** + * Optional. Client scope for this access scope. + */ + clientScope?: Schema$ClientScope; + } + /** + * Access settings represent the set of conditions that must be met for access to be granted. At least one of the fields must be set. + */ + export interface Schema$AccessSettings { + /** + * Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" + */ + accessLevels?: string[] | null; + /** + * Optional. Reauth settings applied to user access on a given AccessScope. + */ + reauthSettings?: Schema$ReauthSettings; + } /** * Identification for an API Operation. */ @@ -295,6 +317,15 @@ export namespace accesscontextmanager_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Client scope represents the application, etc. subject to this binding's restrictions. + */ + export interface Schema$ClientScope { + /** + * Optional. The application that is subject to this binding's scope. + */ + restrictedClientApplication?: Schema$Application; + } /** * A request to commit dry-run specs in all Service Perimeters belonging to an Access Policy. */ @@ -489,10 +520,18 @@ export namespace accesscontextmanager_v1 { * Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" */ name?: string | null; + /** + * Optional. GCSL policy for the group key. + */ + reauthSettings?: Schema$ReauthSettings; /** * Optional. A list of applications that are subject to this binding's restrictions. If the list is empty, the binding restrictions will universally apply to all applications. */ restrictedClientApplications?: Schema$Application[]; + /** + * Optional. A list of scoped access settings that set this binding's restrictions on a subset of applications. This field cannot be set if restricted_client_applications is set. + */ + scopedAccessSettings?: Schema$ScopedAccessSettings[]; } /** * Metadata of GCP Access Binding Long Running Operations. @@ -739,6 +778,31 @@ export namespace accesscontextmanager_v1 { */ version?: number | null; } + /** + * Stores settings related to Google Cloud Session Length including session duration, the type of challenge (i.e. method) they should face when their session expires, and other related settings. + */ + export interface Schema$ReauthSettings { + /** + * Optional. How long a user is allowed to take between actions before a new access token must be issued. Presently only set for Cloud Apps. + */ + maxInactivity?: string | null; + /** + * Optional. Reauth method when users GCP session is up. + */ + reauthMethod?: string | null; + /** + * Optional. The session length. Setting this field to zero is equal to disabling. Reauth. Also can set infinite session by flipping the enabled bit to false below. If use_oidc_max_age is true, for OIDC apps, the session length will be the minimum of this field and OIDC max_age param. + */ + sessionLength?: string | null; + /** + * Optional. Big red button to turn off GCSL. When false, all fields set above will be disregarded and the session length is basically infinite. + */ + sessionLengthEnabled?: boolean | null; + /** + * Optional. Only useful for OIDC apps. When false, the OIDC max_age param, if passed in the authentication request will be ignored. When true, the re-auth period will be the minimum of the session_length field and the max_age OIDC param. + */ + useOidcMaxAge?: boolean | null; + } /** * A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. */ @@ -783,6 +847,23 @@ export namespace accesscontextmanager_v1 { */ servicePerimeters?: Schema$ServicePerimeter[]; } + /** + * A relationship between access settings and its scope. + */ + export interface Schema$ScopedAccessSettings { + /** + * Optional. Access settings for this scoped access settings. This field may be empty if dry_run_settings is set. + */ + activeSettings?: Schema$AccessSettings; + /** + * Optional. Dry-run access settings for this scoped access settings. This field may be empty if active_settings is set. + */ + dryRunSettings?: Schema$AccessSettings; + /** + * Optional. Application, etc. to which the access settings will be applied to. Implicitly, this is the scoped access settings key; as such, it must be unique and non-empty. + */ + scope?: Schema$AccessScope; + } /** * `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. */ @@ -4751,12 +4832,16 @@ export namespace accesscontextmanager_v1 { } export interface Params$Resource$Organizations$Gcpuseraccessbindings$Patch extends StandardParameters { + /** + * Optional. This field will be used to control whether or not scoped access settings are appended to the existing list of scoped access settings. If true, the scoped access settings in the request will be appended to the existing list of scoped access settings. If false, the scoped access settings in the request replace the existing list of scoped access settings. + */ + appendScopedAccessSettings?: boolean; /** * Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" */ 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`. 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`, `reauth_settings`, `scoped_access_settings`. update_mask { paths: "access_levels" \} */ updateMask?: string; diff --git a/src/apis/adexchangebuyer2/v2beta1.ts b/src/apis/adexchangebuyer2/v2beta1.ts index 234335b370..a1c4a1b211 100644 --- a/src/apis/adexchangebuyer2/v2beta1.ts +++ b/src/apis/adexchangebuyer2/v2beta1.ts @@ -2107,19 +2107,19 @@ export namespace adexchangebuyer2_v2beta1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 165c5cd01a..dd1429b56d 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -1079,7 +1079,7 @@ export namespace admin_directory_v1 { */ commandType?: string | null; /** - * The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { "volume": 50 \}. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true \}. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. * `REBOOT`: Payload is a stringified JSON object in the form: { "user_session_delay_seconds": 300 \}. The delay has to be in the range [0, 300]. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": []\}\} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log). + * The payload for the command, provide it only if command supports it. The following commands support adding payload: * `SET_VOLUME`: Payload is a stringified JSON object in the form: { "volume": 50 \}. The volume has to be an integer in the range [0,100]. * `DEVICE_START_CRD_SESSION`: Payload is optionally a stringified JSON object in the form: { "ackedUserPresence": true, "crdSessionType": string \}. `ackedUserPresence` is a boolean. By default, `ackedUserPresence` is set to `false`. To start a Chrome Remote Desktop session for an active device, set `ackedUserPresence` to `true`. `crdSessionType` can only select from values `private` (which grants the remote admin exclusive control of the ChromeOS device) or `shared` (which allows the admin and the local user to share control of the ChromeOS device). If not set, `crdSessionType` defaults to `shared`. * `REBOOT`: Payload is a stringified JSON object in the form: { "user_session_delay_seconds": 300 \}. The `user_session_delay_seconds` is the amount of seconds to wait before rebooting the device if a user is logged in. It has to be an integer in the range [0,300]. When payload is not present for reboot, 0 delay is the default. Note: This only applies if an actual user is logged in, including a Guest. If the device is in the login screen or in Kiosk mode the value is not respected and the device immediately reboots. * `FETCH_SUPPORT_PACKET`: Payload is optionally a stringified JSON object in the form: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": []\}\} The list of available `data_collector_enums` are as following: Chrome System Information (1), Crash IDs (2), Memory Details (3), UI Hierarchy (4), Additional ChromeOS Platform Logs (5), Device Event (6), Intel WiFi NICs Debug Dump (7), Touch Events (8), Lacros (9), Lacros System Information (10), ChromeOS Flex Logs (11), DBus Details (12), ChromeOS Network Routes (13), ChromeOS Shill (Connection Manager) Logs (14), Policies (15), ChromeOS System State and Logs (16), ChromeOS System Logs (17), ChromeOS Chrome User Logs (18), ChromeOS Bluetooth (19), ChromeOS Connected Input Devices (20), ChromeOS Traffic Counters (21), ChromeOS Virtual Keyboard (22), ChromeOS Network Health (23). See more details in [help article](https://support.google.com/chrome/a?p=remote-log). */ payload?: string | null; } @@ -7585,7 +7585,7 @@ export namespace admin_directory_v1 { */ sortOrder?: string; /** - * Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. + * Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object. Cannot be used with the `customer` parameter. */ userKey?: string; } diff --git a/src/apis/adsensehost/README.md b/src/apis/adsensehost/README.md index d76c8f60ef..84eb4200b8 100644 --- a/src/apis/adsensehost/README.md +++ b/src/apis/adsensehost/README.md @@ -2,7 +2,7 @@ # adsensehost -> The AdSense Host API gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities. +> ## Installation diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index 1332c37657..d0939bc587 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -215,7 +215,14 @@ export namespace aiplatform_v1 { y1?: number | null; y2?: number | null; } + /** + * Next ID: 6 + */ export interface Schema$CloudAiLargeModelsVisionRaiInfo { + /** + * List of blocked entities from the blocklist if it is detected. + */ + blockedEntities?: string[] | null; /** * The list of detected labels for different rai categories. */ @@ -650,11 +657,11 @@ export namespace aiplatform_v1 { genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } /** - * Request message for FeaturestoreService.BatchCreateFeatures. + * Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures. */ export interface Schema$GoogleCloudAiplatformV1BatchCreateFeaturesRequest { /** - * Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message. + * Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message. */ requests?: Schema$GoogleCloudAiplatformV1CreateFeatureRequest[]; } @@ -1253,6 +1260,10 @@ export namespace aiplatform_v1 { * Output only. Index of the candidate. */ index?: number | null; + /** + * Output only. Log-likelihood scores for the response tokens and top tokens + */ + logprobsResult?: Schema$GoogleCloudAiplatformV1LogprobsResult; /** * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ @@ -1581,6 +1592,10 @@ export namespace aiplatform_v1 { * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1Content[]; + /** + * Optional. Generation config that the model will use to generate the response. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1GenerationConfig; /** * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ @@ -1775,6 +1790,23 @@ export namespace aiplatform_v1 { */ progressMessage?: string | null; } + /** + * Request message for [NotebookService.CreateNotebookExecutionJob] + */ + export interface Schema$GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest { + /** + * Required. The NotebookExecutionJob to create. + */ + notebookExecutionJob?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; + /** + * Optional. User specified ID for the NotebookExecutionJob. + */ + notebookExecutionJobId?: string | null; + /** + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string | null; + } /** * Metadata information for NotebookService.CreateNotebookRuntimeTemplate. */ @@ -2442,6 +2474,10 @@ export namespace aiplatform_v1 { * Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured. */ privateEndpoints?: Schema$GoogleCloudAiplatformV1IndexPrivateEndpoints; + /** + * Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints. + */ + pscAutomationConfigs?: Schema$GoogleCloudAiplatformV1PSCAutomationConfig[]; /** * Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. */ @@ -3999,10 +4035,18 @@ export namespace aiplatform_v1 { * Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */ bigQuerySource?: Schema$GoogleCloudAiplatformV1BigQuerySource; + /** + * Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores. + */ + dense?: boolean | null; /** * Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */ entityIdColumns?: string[] | null; + /** + * Optional. Set if the data source is not a time-series. + */ + staticDataSource?: boolean | null; /** * Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. */ @@ -4456,6 +4500,10 @@ export namespace aiplatform_v1 { * Output only. Timestamp when this FeatureView was last updated. */ updateTime?: string | null; + /** + * Optional. The Vertex RAG Source that the FeatureView is linked to. + */ + vertexRagSource?: Schema$GoogleCloudAiplatformV1FeatureViewVertexRagSource; } export interface Schema$GoogleCloudAiplatformV1FeatureViewBigQuerySource { /** @@ -4620,6 +4668,19 @@ export namespace aiplatform_v1 { */ totalSlot?: string | null; } + /** + * A Vertex Rag source for features that need to be synced to Online Store. + */ + export interface Schema$GoogleCloudAiplatformV1FeatureViewVertexRagSource { + /** + * Optional. The RAG corpus id corresponding to this FeatureView. + */ + ragCorpusId?: string | null; + /** + * Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED) + */ + uri?: string | null; + } /** * Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned. */ @@ -4955,6 +5016,10 @@ export namespace aiplatform_v1 { * Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 */ parameters?: Schema$GoogleCloudAiplatformV1Schema; + /** + * Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + */ + response?: Schema$GoogleCloudAiplatformV1Schema; } /** * 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. @@ -4965,7 +5030,7 @@ export namespace aiplatform_v1 { */ name?: string | null; /** - * Required. The function response in JSON object format. + * Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. */ response?: {[key: string]: any} | null; } @@ -4999,6 +5064,10 @@ export namespace aiplatform_v1 { * Optional. Generation config. */ generationConfig?: Schema$GoogleCloudAiplatformV1GenerationConfig; + /** + * Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + */ + labels?: {[key: string]: string} | null; /** * Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */ @@ -5024,6 +5093,10 @@ export namespace aiplatform_v1 { * Output only. Generated candidates. */ candidates?: Schema$GoogleCloudAiplatformV1Candidate[]; + /** + * Output only. The model version used to generate the response. + */ + modelVersion?: string | null; /** * Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */ @@ -5062,6 +5135,9 @@ export namespace aiplatform_v1 { * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */ promptTokenCount?: number | null; + /** + * Total token count for prompt and response candidates. + */ totalTokenCount?: number | null; } /** @@ -5076,6 +5152,10 @@ export namespace aiplatform_v1 { * Optional. Frequency penalties. */ frequencyPenalty?: number | null; + /** + * Optional. Logit probabilities. + */ + logprobs?: number | null; /** * Optional. The maximum number of output tokens to generate per message. */ @@ -5084,6 +5164,10 @@ export namespace aiplatform_v1 { * Optional. Positive penalties. */ presencePenalty?: number | null; + /** + * Optional. If true, export the logprobs results in response. + */ + responseLogprobs?: boolean | null; /** * Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */ @@ -6535,6 +6619,45 @@ export namespace aiplatform_v1 { */ tuningJobs?: Schema$GoogleCloudAiplatformV1TuningJob[]; } + /** + * Logprobs Result + */ + export interface Schema$GoogleCloudAiplatformV1LogprobsResult { + /** + * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + */ + chosenCandidates?: Schema$GoogleCloudAiplatformV1LogprobsResultCandidate[]; + /** + * Length = total number of decoding steps. + */ + topCandidates?: Schema$GoogleCloudAiplatformV1LogprobsResultTopCandidates[]; + } + /** + * Candidate for the logprobs token and score. + */ + export interface Schema$GoogleCloudAiplatformV1LogprobsResultCandidate { + /** + * The candidate's log probability. + */ + logProbability?: number | null; + /** + * The candidate’s token string value. + */ + token?: string | null; + /** + * The candidate’s token id value. + */ + tokenId?: number | null; + } + /** + * Candidates with top log probabilities at each decoding step. + */ + export interface Schema$GoogleCloudAiplatformV1LogprobsResultTopCandidates { + /** + * Sorted by log probability in descending order. + */ + candidates?: Schema$GoogleCloudAiplatformV1LogprobsResultCandidate[]; + } /** * Request message for VizierService.LookupStudy. */ @@ -9336,6 +9459,19 @@ export namespace aiplatform_v1 { */ projectId?: string | null; } + /** + * PSC config that is used to automatically create forwarding rule via ServiceConnectionMap. + */ + export interface Schema$GoogleCloudAiplatformV1PSCAutomationConfig { + /** + * Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in '12345', and {network\} is network name. + */ + network?: string | null; + /** + * Required. Project id used to create forwarding rule. + */ + projectId?: string | null; + } /** * A Model Garden Publisher Model. */ @@ -10233,6 +10369,27 @@ export namespace aiplatform_v1 { */ viewCount?: string | null; } + /** + * Request message for GenAiTuningService.RebaseTunedModel. + */ + export interface Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest { + /** + * Optional. The Google Cloud Storage location to write the artifacts. + */ + artifactDestination?: Schema$GoogleCloudAiplatformV1GcsDestination; + /** + * Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section. + */ + deployToSameEndpoint?: boolean | null; + /** + * Required. TunedModel reference to retrieve the legacy model information. + */ + tunedModelRef?: Schema$GoogleCloudAiplatformV1TunedModelRef; + /** + * Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs. + */ + tuningJob?: Schema$GoogleCloudAiplatformV1TuningJob; + } /** * Details of operations that perform reboot PersistentResource. */ @@ -10670,6 +10827,10 @@ export namespace aiplatform_v1 { * Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false. */ catchUp?: boolean | null; + /** + * Request for NotebookService.CreateNotebookExecutionJob. + */ + createNotebookExecutionJobRequest?: Schema$GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest; /** * Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project\}/locations/{location\}). */ @@ -10774,9 +10935,13 @@ export namespace aiplatform_v1 { timeout?: string | null; } /** - * 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). More fields may be added in the future as needed. + * 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$GoogleCloudAiplatformV1Schema { + /** + * Optional. The value should be validated against any (one or more) of the subschemas in the list. + */ + anyOf?: Schema$GoogleCloudAiplatformV1Schema[]; /** * Optional. Default value of the data. */ @@ -10845,6 +11010,10 @@ export namespace aiplatform_v1 { * Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. */ properties?: {[key: string]: Schema$GoogleCloudAiplatformV1Schema} | null; + /** + * 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. Required properties of Type.OBJECT. */ @@ -12240,6 +12409,10 @@ export namespace aiplatform_v1 { * Whether the prompt dataset has prompt variable. */ hasPromptVariable?: boolean | null; + /** + * Whether or not the user has enabled logit probabilities in the model parameters. + */ + logprobs?: boolean | null; /** * Value of the maximum number of tokens generated set when the dataset was saved. */ @@ -12252,6 +12425,14 @@ export namespace aiplatform_v1 { * Type of the prompt dataset. */ promptType?: string | null; + /** + * Seeding enables model to return a deterministic response on a best effort basis. Determinism isn't guaranteed. This field determines whether or not seeding is enabled. + */ + seedEnabled?: boolean | null; + /** + * The actual value of the seed. + */ + seedValue?: string | null; /** * Customized stop sequences. */ @@ -14522,7 +14703,7 @@ export namespace aiplatform_v1 { userOutputTokenDistribution?: Schema$GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution; } /** - * Tuning Spec for Supervised Tuning. + * Tuning Spec for Supervised Tuning for first party models. */ export interface Schema$GoogleCloudAiplatformV1SupervisedTuningSpec { /** @@ -14543,7 +14724,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest {} /** - * Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + * Response message for FeatureOnlineStoreAdminService.SyncFeatureView. */ export interface Schema$GoogleCloudAiplatformV1SyncFeatureViewResponse { /** @@ -14939,7 +15120,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1Tool { /** - * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ functionDeclarations?: Schema$GoogleCloudAiplatformV1FunctionDeclaration[]; /** @@ -15328,6 +15509,23 @@ export namespace aiplatform_v1 { */ model?: string | null; } + /** + * TunedModel Reference for legacy model migration. + */ + export interface Schema$GoogleCloudAiplatformV1TunedModelRef { + /** + * Support migration from tuning job list page, from bison model to gemini model. + */ + pipelineJob?: string | null; + /** + * Support migration from model registry. + */ + tunedModel?: string | null; + /** + * Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above. + */ + tuningJob?: string | null; + } /** * The tuning data statistic values for TuningJob. */ @@ -22598,7 +22796,7 @@ export namespace aiplatform_v1 { } /** - * Lists Annotations belongs to a dataitem + * Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -29969,7 +30167,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Featuregroups$Create 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 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. + * 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; /** @@ -31749,6 +31947,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$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$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 FeatureOnlineStores in a given project and location. * @@ -31939,6 +32231,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$Featureonlinestores$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy, + 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 + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$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$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 + '/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$Featureonlinestores$Create @@ -31975,6 +32459,17 @@ export namespace aiplatform_v1 { */ 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 { /** @@ -32014,6 +32509,29 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1FeatureOnlineStore; } + 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; @@ -32413,6 +32931,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$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$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 FeatureViews in a given FeatureOnlineStore. * @@ -32702,6 +33314,100 @@ export namespace aiplatform_v1 { } } + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Featureviews$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); + } + } + /** * Triggers on-demand sync for the FeatureView. * @@ -32799,6 +33505,104 @@ export namespace aiplatform_v1 { ); } } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) 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$Featureonlinestores$Featureviews$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$Featureonlinestores$Featureviews$Create @@ -32847,6 +33651,17 @@ export namespace aiplatform_v1 { */ 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 { /** @@ -32898,6 +33713,18 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1SearchNearestEntitiesRequest; } + 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$Sync extends StandardParameters { /** @@ -32910,6 +33737,17 @@ export namespace aiplatform_v1 { */ requestBody?: Schema$GoogleCloudAiplatformV1SyncFeatureViewRequest; } + 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; @@ -37223,7 +38061,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate extends StandardParameters { /** - * Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * 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; @@ -73988,6 +74826,101 @@ export namespace aiplatform_v1 { ); } } + + /** + * Rebase a TunedModel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: StreamMethodOptions + ): GaxiosPromise; + rebaseTunedModel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options?: MethodOptions + ): GaxiosPromise; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + 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}/tuningJobs:rebaseTunedModel' + ).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$Tuningjobs$Cancel @@ -74040,6 +74973,18 @@ export namespace aiplatform_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + extends StandardParameters { + /** + * Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1RebaseTunedModelRequest; + } export class Resource$Projects$Locations$Tuningjobs$Operations { context: APIRequestContext; @@ -74136,6 +75081,95 @@ export namespace aiplatform_v1 { } } + /** + * 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$Tuningjobs$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$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); + } + } + /** * 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. * @@ -74335,6 +75369,13 @@ export namespace aiplatform_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Get extends StandardParameters { /** diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 11fb60ce47..cff8a42df2 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -217,7 +217,14 @@ export namespace aiplatform_v1beta1 { y1?: number | null; y2?: number | null; } + /** + * Next ID: 6 + */ export interface Schema$CloudAiLargeModelsVisionRaiInfo { + /** + * List of blocked entities from the blocklist if it is detected. + */ + blockedEntities?: string[] | null; /** * The list of detected labels for different rai categories. */ @@ -482,6 +489,15 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * The generic reusable api auth config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ApiAuth { + /** + * The API secret. + */ + apiKeyConfig?: Schema$GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig; + } /** * The API secret. */ @@ -544,6 +560,27 @@ export namespace aiplatform_v1beta1 { */ uri?: string | null; } + /** + * The definition of a artifact type in MLMD. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ArtifactTypeSchema { + /** + * Contains a raw YAML string, describing the format of the properties of the type. + */ + instanceSchema?: string | null; + /** + * The name of the type. The format of the title must be: `.`. Examples: - `aiplatform.Model` - `acme.CustomModel` When this field is set, the type must be pre-registered in the MLMD store. + */ + schemaTitle?: string | null; + /** + * Points to a YAML file stored on Cloud Storage describing the format. Deprecated. Use PipelineArtifactTypeSchema.schema_title or PipelineArtifactTypeSchema.instance_schema instead. + */ + schemaUri?: string | null; + /** + * The schema version of the artifact. If the value is not set, it defaults to the latest version in the system. + */ + schemaVersion?: string | null; + } /** * Metadata information for NotebookService.AssignNotebookRuntime. */ @@ -607,6 +644,49 @@ export namespace aiplatform_v1beta1 { */ outputName?: string | null; } + /** + * Request message for AugmentPrompt. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AugmentPromptRequest { + /** + * Optional. Input content to augment, only text format is supported for now. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Optional. Metadata of the backend deployed model. + */ + model?: Schema$GoogleCloudAiplatformV1beta1AugmentPromptRequestModel; + /** + * Optional. Retrieves contexts from the Vertex RagStore. + */ + vertexRagStore?: Schema$GoogleCloudAiplatformV1beta1VertexRagStore; + } + /** + * Metadata of the backend deployed model. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AugmentPromptRequestModel { + /** + * Optional. The model that the user will send the augmented prompt for content generation. + */ + model?: string | null; + /** + * Optional. The model version of the backend deployed model. + */ + modelVersion?: string | null; + } + /** + * Response message for AugmentPrompt. + */ + export interface Schema$GoogleCloudAiplatformV1beta1AugmentPromptResponse { + /** + * Augmented prompt, only text format is supported for now. + */ + augmentedPrompt?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Retrieved facts from RAG data sources. + */ + facts?: Schema$GoogleCloudAiplatformV1beta1Fact[]; + } /** * Auth configuration to run the extension. */ @@ -760,11 +840,11 @@ export namespace aiplatform_v1beta1 { genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } /** - * Request message for FeaturestoreService.BatchCreateFeatures. + * Request message for FeaturestoreService.BatchCreateFeatures. Request message for FeatureRegistryService.BatchCreateFeatures. */ export interface Schema$GoogleCloudAiplatformV1beta1BatchCreateFeaturesRequest { /** - * Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message. + * Required. The request message specifying the Features to create. All Features must be created under the same parent EntityType / FeatureGroup. The `parent` field in each child request message can be omitted. If `parent` is set in a child request, then the value must match the `parent` value in this request message. */ requests?: Schema$GoogleCloudAiplatformV1beta1CreateFeatureRequest[]; } @@ -1381,6 +1461,35 @@ export namespace aiplatform_v1beta1 { * Output only. When the cache entry was last updated in UTC time. */ updateTime?: string | null; + /** + * Output only. Metadata on the usage of the cached content. + */ + usageMetadata?: Schema$GoogleCloudAiplatformV1beta1CachedContentUsageMetadata; + } + /** + * Metadata on the usage of the cached content. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CachedContentUsageMetadata { + /** + * Duration of audio in seconds. + */ + audioDurationSeconds?: number | null; + /** + * Number of images. + */ + imageCount?: number | null; + /** + * Number of text characters. + */ + textCount?: number | null; + /** + * Total number of tokens that the cached content consumes. + */ + totalTokenCount?: number | null; + /** + * Duration of video in seconds. + */ + videoDurationSeconds?: number | null; } /** * Request message for JobService.CancelBatchPredictionJob. @@ -1446,6 +1555,10 @@ export namespace aiplatform_v1beta1 { * Output only. Index of the candidate. */ index?: number | null; + /** + * Output only. Log-likelihood scores for the response tokens and top tokens + */ + logprobsResult?: Schema$GoogleCloudAiplatformV1beta1LogprobsResult; /** * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ @@ -1519,6 +1632,27 @@ export namespace aiplatform_v1beta1 { */ citations?: Schema$GoogleCloudAiplatformV1beta1Citation[]; } + /** + * Claim that is extracted from the input text and facts that support it. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Claim { + /** + * Index in the input text where the claim ends (exclusive). + */ + endIndex?: number | null; + /** + * Indexes of the facts supporting this claim. + */ + factIndexes?: number[] | null; + /** + * Confidence score of this corroboration. + */ + score?: number | null; + /** + * Index in the input text where the claim starts (inclusive). + */ + startIndex?: number | null; + } /** * Input for coherence metric. */ @@ -1766,6 +1900,58 @@ export namespace aiplatform_v1beta1 { */ modelVersionId?: string | null; } + /** + * RagCorpus status. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CorpusStatus { + /** + * Output only. Only when the `state` field is ERROR. + */ + errorStatus?: string | null; + /** + * Output only. RagCorpus life state. + */ + state?: string | null; + } + /** + * Request message for CorroborateContent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CorroborateContentRequest { + /** + * Optional. Input content to corroborate, only text format is supported for now. + */ + content?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. Facts used to generate the text can also be used to corroborate the text. + */ + facts?: Schema$GoogleCloudAiplatformV1beta1Fact[]; + /** + * Optional. Parameters that can be set to override default settings per request. + */ + parameters?: Schema$GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters; + } + /** + * Parameters that can be overrided per request. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CorroborateContentRequestParameters { + /** + * Optional. Only return claims with citation score larger than the threshold. + */ + citationThreshold?: number | null; + } + /** + * Response message for CorroborateContent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CorroborateContentResponse { + /** + * Claims that are extracted from the input content and facts that support the claims. + */ + claims?: Schema$GoogleCloudAiplatformV1beta1Claim[]; + /** + * Confidence score of corroborating content. Value is [0,1] with 1 is the most confidence. + */ + corroborationScore?: number | null; + } /** * Request message for PredictionService.CountTokens. */ @@ -1774,6 +1960,10 @@ export namespace aiplatform_v1beta1 { * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Optional. Generation config that the model will use to generate the response. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfig; /** * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ @@ -2787,6 +2977,10 @@ export namespace aiplatform_v1beta1 { * Output only. Provides paths for users to send requests directly to the deployed index services running on Cloud via private services access. This field is populated if network is configured. */ privateEndpoints?: Schema$GoogleCloudAiplatformV1beta1IndexPrivateEndpoints; + /** + * Optional. If set for PSC deployed index, PSC connection will be automatically created after deployment is done and the endpoint information is populated in private_endpoints.psc_automated_endpoints. + */ + pscAutomationConfigs?: Schema$GoogleCloudAiplatformV1beta1PSCAutomationConfig[]; /** * Optional. A list of reserved ip ranges under the VPC network that can be used for this DeployedIndex. If set, we will deploy the index within the provided ip ranges. Otherwise, the index might be deployed to any ip ranges under the provided VPC network. The value should be the name of the address (https://cloud.google.com/compute/docs/reference/rest/v1/addresses) Example: ['vertex-ai-ip-range']. For more information about subnets and network IP ranges, please see https://cloud.google.com/vpc/docs/subnets#manually_created_subnet_ip_ranges. */ @@ -4447,6 +4641,31 @@ export namespace aiplatform_v1beta1 { */ serviceDirectory?: string | null; } + /** + * The fact used in grounding. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Fact { + /** + * Query that is used to retrieve this fact. + */ + query?: string | null; + /** + * If present, the summary/snippet of the fact. + */ + summary?: string | null; + /** + * If present, it refers to the title of this fact. + */ + title?: string | null; + /** + * If present, this uri links to the source of the fact. + */ + uri?: string | null; + /** + * If present, the distance between the query vector and this fact vector. + */ + vectorDistance?: number | null; + } /** * Feature Metadata information. For example, color is a feature that describes an apple. */ @@ -4545,10 +4764,18 @@ export namespace aiplatform_v1beta1 { * Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. */ bigQuerySource?: Schema$GoogleCloudAiplatformV1beta1BigQuerySource; + /** + * Optional. If set, all feature values will be fetched from a single row per unique entityId including nulls. If not set, will collapse all rows for each unique entityId into a singe row with any non-null values if present, if no non-null values are present will sync null. ex: If source has schema `(entity_id, feature_timestamp, f0, f1)` and the following rows: `(e1, 2020-01-01T10:00:00.123Z, 10, 15)` `(e1, 2020-02-01T10:00:00.123Z, 20, null)` If dense is set, `(e1, 20, null)` is synced to online stores. If dense is not set, `(e1, 20, 15)` is synced to online stores. + */ + dense?: boolean | null; /** * Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */ entityIdColumns?: string[] | null; + /** + * Optional. Set if the data source is not a time-series. + */ + staticDataSource?: boolean | null; /** * Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureView ) will treat time-series sources. If not set, will treat the source as a time-series source with `feature_timestamp` as timestamp column and no scan boundary. */ @@ -5003,6 +5230,10 @@ export namespace aiplatform_v1beta1 { * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` */ name?: string | null; + /** + * Optional. Configuration for FeatureView created under Optimized FeatureOnlineStore. + */ + optimizedConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig; /** * Output only. Reserved for future use. */ @@ -5031,6 +5262,10 @@ export namespace aiplatform_v1beta1 { * Optional. Deprecated: please use FeatureView.index_config instead. */ vectorSearchConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig; + /** + * Optional. The Vertex RAG Source that the FeatureView is linked to. + */ + vertexRagSource?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource; } export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource { /** @@ -5136,6 +5371,15 @@ export namespace aiplatform_v1beta1 { */ leafNodeEmbeddingCount?: string | null; } + /** + * Configuration for FeatureViews created in Optimized FeatureOnlineStore. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewOptimizedConfig { + /** + * Optional. A description of resources that the FeatureView uses, which to large degree are decided by Vertex AI, and optionally allows only a modest additional configuration. If min_replica_count is not set, the default value is 2. If max_replica_count is not set, the default value is 6. The max allowed replica count is 1000. + */ + automaticResources?: Schema$GoogleCloudAiplatformV1beta1AutomaticResources; + } /** * FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store. */ @@ -5235,6 +5479,19 @@ export namespace aiplatform_v1beta1 { */ leafNodeEmbeddingCount?: string | null; } + /** + * A Vertex Rag source for features that need to be synced to Online Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewVertexRagSource { + /** + * Optional. The RAG corpus id corresponding to this FeatureView. + */ + ragCorpusId?: string | null; + /** + * Required. The BigQuery view/table URI that will be materialized on each manual sync trigger. The table/view is expected to have the following columns and types at least: - `corpus_id` (STRING, NULLABLE/REQUIRED) - `file_id` (STRING, NULLABLE/REQUIRED) - `chunk_id` (STRING, NULLABLE/REQUIRED) - `chunk_data_type` (STRING, NULLABLE/REQUIRED) - `chunk_data` (STRING, NULLABLE/REQUIRED) - `embeddings` (FLOAT, REPEATED) - `file_original_uri` (STRING, NULLABLE/REQUIRED) + */ + uri?: string | null; + } /** * Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned. */ @@ -5308,6 +5565,19 @@ export namespace aiplatform_v1beta1 { */ mimeType?: string | null; } + /** + * RagFile status. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FileStatus { + /** + * Output only. Only when the `state` field is ERROR. + */ + errorStatus?: string | null; + /** + * Output only. RagFile state. + */ + state?: string | null; + } /** * Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. */ @@ -5592,7 +5862,7 @@ export namespace aiplatform_v1beta1 { */ name?: string | null; /** - * Required. The function response in JSON object format. + * Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. */ response?: {[key: string]: any} | null; } @@ -5660,6 +5930,10 @@ export namespace aiplatform_v1beta1 { * Optional. Generation config. */ generationConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfig; + /** + * Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + */ + labels?: {[key: string]: string} | null; /** * Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */ @@ -5685,6 +5959,10 @@ export namespace aiplatform_v1beta1 { * Output only. Generated candidates. */ candidates?: Schema$GoogleCloudAiplatformV1beta1Candidate[]; + /** + * Output only. The model version used to generate the response. + */ + modelVersion?: string | null; /** * Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */ @@ -5715,6 +5993,10 @@ export namespace aiplatform_v1beta1 { * Usage metadata about response(s). */ export interface Schema$GoogleCloudAiplatformV1beta1GenerateContentResponseUsageMetadata { + /** + * Output only. Number of tokens in the cached part in the input (the cached content). + */ + cachedContentTokenCount?: number | null; /** * Number of tokens in the response(s). */ @@ -5723,6 +6005,9 @@ export namespace aiplatform_v1beta1 { * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */ promptTokenCount?: number | null; + /** + * Total token count for prompt and response candidates. + */ totalTokenCount?: number | null; } /** @@ -5754,6 +6039,10 @@ export namespace aiplatform_v1beta1 { * Optional. Frequency penalties. */ frequencyPenalty?: number | null; + /** + * Optional. Logit probabilities. + */ + logprobs?: number | null; /** * Optional. The maximum number of output tokens to generate per message. */ @@ -5762,6 +6051,10 @@ export namespace aiplatform_v1beta1 { * Optional. Positive penalties. */ presencePenalty?: number | null; + /** + * Optional. If true, export the logprobs results in response. + */ + responseLogprobs?: boolean | null; /** * Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */ @@ -6281,6 +6574,14 @@ export namespace aiplatform_v1beta1 { * Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. */ maxEmbeddingRequestsPerMin?: number | null; + /** + * The BigQuery destination to write partial failures to. It should be a bigquery table resource name (e.g. "bq://projectId.bqDatasetId.bqTableId"). If the dataset id does not exist, it will be created. If the table does not exist, it will be created with the expected schema. If the table exists, the schema will be validated and data will be added to this existing table. + */ + partialFailureBigquerySink?: Schema$GoogleCloudAiplatformV1beta1BigQueryDestination; + /** + * The Cloud Storage path to write partial failures to. + */ + partialFailureGcsSink?: Schema$GoogleCloudAiplatformV1beta1GcsDestination; /** * Specifies the size and overlap of chunks after importing RagFiles. */ @@ -6289,6 +6590,10 @@ export namespace aiplatform_v1beta1 { * Specifies the parsing config for RagFiles. */ ragFileParsingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileParsingConfig; + /** + * SharePoint sources. + */ + sharePointSources?: Schema$GoogleCloudAiplatformV1beta1SharePointSources; /** * Slack channels with their corresponding access tokens. */ @@ -7441,6 +7746,45 @@ export namespace aiplatform_v1beta1 { */ tuningJobs?: Schema$GoogleCloudAiplatformV1beta1TuningJob[]; } + /** + * Logprobs Result + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResult { + /** + * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + */ + chosenCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; + /** + * Length = total number of decoding steps. + */ + topCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[]; + } + /** + * Candidate for the logprobs token and score. + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate { + /** + * The candidate's log probability. + */ + logProbability?: number | null; + /** + * The candidate’s token string value. + */ + token?: string | null; + /** + * The candidate’s token id value. + */ + tokenId?: number | null; + } + /** + * Candidates with top log probabilities at each decoding step. + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates { + /** + * Sorted by log probability in descending order. + */ + candidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; + } /** * Request message for VizierService.LookupStudy. */ @@ -10369,10 +10713,18 @@ export namespace aiplatform_v1beta1 { * The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the Pipeline Job's workload should be peered. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. Private services access must already be configured for the network. Pipeline job will apply the network configuration to the Google Cloud resources being launched, if applied, such as Vertex AI Training or Dataflow job. If left unspecified, the workload is not peered with any network. */ network?: string | null; + /** + * Output only. The original pipeline job id if this pipeline job is a rerun of a previous pipeline job. + */ + originalPipelineJobId?: string | null; /** * The spec of the pipeline. */ pipelineSpec?: {[key: string]: any} | null; + /** + * Output only. The rerun configs for each task in the pipeline job. By default, the rerun will: 1. Use the same input artifacts as the original run. 2. Use the same input parameters as the original run. 3. Skip all the tasks that are already succeeded in the original run. 4. Rerun all the tasks that are not succeeded in the original run. By providing this field, users can override the default behavior and specify the rerun config for each task. + */ + pipelineTaskRerunConfigs?: Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig[]; /** * Optional. Whether to do component level validations before job creation. */ @@ -10617,6 +10969,57 @@ export namespace aiplatform_v1beta1 { */ job?: string | null; } + /** + * User provided rerun config to submit a rerun pipelinejob. This includes 1. Which task to rerun 2. User override input parameters and artifacts. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfig { + /** + * Output only. The runtime input of the task overridden by the user. + */ + inputs?: Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs; + /** + * Output only. Whether to skip downstream tasks. Default value is False. + */ + skipDownstreamTasks?: boolean | null; + /** + * Output only. Whether to skip this task. Default value is False. + */ + skipTask?: boolean | null; + /** + * Output only. The system generated ID of the task. Retrieved from original run. + */ + taskId?: string | null; + /** + * Output only. The name of the task. + */ + taskName?: string | null; + } + /** + * A list of artifact metadata. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList { + /** + * Output only. A list of artifact metadata. + */ + artifacts?: Schema$GoogleCloudAiplatformV1beta1RuntimeArtifact[]; + } + /** + * Runtime inputs data of the task. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigInputs { + /** + * Output only. Input artifacts. + */ + artifacts?: { + [ + key: string + ]: Schema$GoogleCloudAiplatformV1beta1PipelineTaskRerunConfigArtifactList; + } | null; + /** + * Output only. Input parameters. + */ + parameterValues?: {[key: string]: any} | null; + } /** * Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. */ @@ -10819,6 +11222,10 @@ export namespace aiplatform_v1beta1 { * Required. If true, expose the IndexEndpoint via private service connect. */ enablePrivateServiceConnect?: boolean | null; + /** + * Optional. If set to true, enable secure private service connect with IAM authorization. Otherwise, private service connect will be done without authorization. Note latency will be slightly increased if authorization is enabled. + */ + enableSecurePrivateServiceConnect?: boolean | null; /** * A list of Projects from which the forwarding rule will target the service attachment. */ @@ -10871,6 +11278,19 @@ export namespace aiplatform_v1beta1 { */ projectId?: string | null; } + /** + * PSC config that is used to automatically create forwarding rule via ServiceConnectionMap. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PSCAutomationConfig { + /** + * Required. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in '12345', and {network\} is network name. + */ + network?: string | null; + /** + * Required. Project id used to create forwarding rule. + */ + projectId?: string | null; + } /** * Configuration for PSC-I. */ @@ -11642,7 +12062,7 @@ export namespace aiplatform_v1beta1 { */ distance?: number | null; /** - * For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. + * If the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. */ sourceUri?: string | null; /** @@ -11658,6 +12078,10 @@ export namespace aiplatform_v1beta1 { * A RagCorpus is a RagFile container and a project can have multiple RagCorpora. */ export interface Schema$GoogleCloudAiplatformV1beta1RagCorpus { + /** + * Output only. RagCorpus state. + */ + corpusStatus?: Schema$GoogleCloudAiplatformV1beta1CorpusStatus; /** * Output only. Timestamp when this RagCorpus was created. */ @@ -11678,6 +12102,10 @@ export namespace aiplatform_v1beta1 { * Optional. Immutable. The embedding model config of the RagCorpus. */ ragEmbeddingModelConfig?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig; + /** + * Optional. Immutable. The Vector DB config of the RagCorpus. + */ + ragVectorDbConfig?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfig; /** * Output only. Timestamp when this RagCorpus was last updated. */ @@ -11772,6 +12200,10 @@ export namespace aiplatform_v1beta1 { * Required. The display name of the RagFile. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ displayName?: string | null; + /** + * Output only. State of the RagFile. + */ + fileStatus?: Schema$GoogleCloudAiplatformV1beta1FileStatus; /** * Output only. Google Cloud Storage location of the RagFile. It does not support wildcards in the Cloud Storage uri for now. */ @@ -11792,6 +12224,10 @@ export namespace aiplatform_v1beta1 { * Output only. The type of the RagFile. */ ragFileType?: string | null; + /** + * The RagFile is imported from a SharePoint source. + */ + sharePointSources?: Schema$GoogleCloudAiplatformV1beta1SharePointSources; /** * Output only. The size of the RagFile in bytes. */ @@ -11853,6 +12289,83 @@ export namespace aiplatform_v1beta1 { */ alpha?: number | null; } + /** + * Config for the Vector DB to use for RAG. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfig { + /** + * Authentication config for the chosen Vector DB. + */ + apiAuth?: Schema$GoogleCloudAiplatformV1beta1ApiAuth; + /** + * The config for the Pinecone. + */ + pinecone?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone; + /** + * The config for the RAG-managed Vector DB. + */ + ragManagedDb?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb; + /** + * The config for the Vertex Feature Store. + */ + vertexFeatureStore?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore; + /** + * The config for the Vertex Vector Search. + */ + vertexVectorSearch?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch; + /** + * The config for the Weaviate. + */ + weaviate?: Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate; + } + /** + * The config for the Pinecone. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigPinecone { + /** + * Pinecone index name. This value cannot be changed after it's set. + */ + indexName?: string | null; + } + /** + * The config for the default RAG-managed Vector DB. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigRagManagedDb {} + /** + * The config for the Vertex Feature Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexFeatureStore { + /** + * The resource name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureViewResourceName?: string | null; + } + /** + * The config for the Vertex Vector Search. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigVertexVectorSearch { + /** + * The resource name of the Index. Format: `projects/{project\}/locations/{location\}/indexes/{index\}` + */ + index?: string | null; + /** + * The resource name of the Index Endpoint. Format: `projects/{project\}/locations/{location\}/indexEndpoints/{index_endpoint\}` + */ + indexEndpoint?: string | null; + } + /** + * The config for the Weaviate. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagVectorDbConfigWeaviate { + /** + * The corresponding collection this corpus maps to. This value cannot be changed after it's set. + */ + collectionName?: string | null; + /** + * Weaviate DB instance HTTP endpoint. e.g. 34.56.78.90:8080 Vertex RAG only supports HTTP connection to Weaviate. This value cannot be changed after it's set. + */ + httpEndpoint?: string | null; + } /** * Request message for PredictionService.RawPredict. */ @@ -12130,6 +12643,27 @@ export namespace aiplatform_v1beta1 { */ requirementsGcsUri?: string | null; } + /** + * Request message for GenAiTuningService.RebaseTunedModel. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RebaseTunedModelRequest { + /** + * Optional. The Google Cloud Storage location to write the artifacts. + */ + artifactDestination?: Schema$GoogleCloudAiplatformV1beta1GcsDestination; + /** + * Optional. By default, bison to gemini migration will always create new model/endpoint, but for gemini-1.0 to gemini-1.5 migration, we default deploy to the same endpoint. See details in this Section. + */ + deployToSameEndpoint?: boolean | null; + /** + * Required. TunedModel reference to retrieve the legacy model information. + */ + tunedModelRef?: Schema$GoogleCloudAiplatformV1beta1TunedModelRef; + /** + * Optional. The TuningJob to be updated. Users can use this TuningJob field to overwrite tuning configs. + */ + tuningJob?: Schema$GoogleCloudAiplatformV1beta1TuningJob; + } /** * Details of operations that perform reboot PersistentResource. */ @@ -12474,6 +13008,39 @@ export namespace aiplatform_v1beta1 { */ useStemmer?: boolean | null; } + /** + * The definition of a runtime artifact. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RuntimeArtifact { + /** + * The custom properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. + */ + customProperties?: { + [key: string]: Schema$GoogleCloudAiplatformV1beta1Value; + } | null; + /** + * Properties of the Artifact. + */ + metadata?: {[key: string]: any} | null; + /** + * The name of an artifact. + */ + name?: string | null; + /** + * The properties of the artifact. Deprecated. Use RuntimeArtifact.metadata instead. + */ + properties?: { + [key: string]: Schema$GoogleCloudAiplatformV1beta1Value; + } | null; + /** + * The type of the artifact. + */ + type?: Schema$GoogleCloudAiplatformV1beta1ArtifactTypeSchema; + /** + * The URI of the artifact. + */ + uri?: string | null; + } /** * Runtime configuration to run the extension. */ @@ -12827,9 +13394,13 @@ export namespace aiplatform_v1beta1 { timeout?: string | null; } /** - * 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). More fields may be added in the future as needed. + * 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. The value should be validated against any (one or more) of the subschemas in the list. + */ + anyOf?: Schema$GoogleCloudAiplatformV1beta1Schema[]; /** * Optional. Default value of the data. */ @@ -12900,6 +13471,10 @@ export namespace aiplatform_v1beta1 { properties?: { [key: string]: Schema$GoogleCloudAiplatformV1beta1Schema; } | null; + /** + * 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. Required properties of Type.OBJECT. */ @@ -15718,6 +16293,56 @@ export namespace aiplatform_v1beta1 { */ serviceAccount?: string | null; } + /** + * The SharePointSources to pass to ImportRagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SharePointSources { + /** + * The SharePoint sources. + */ + sharePointSources?: Schema$GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource[]; + } + /** + * An individual SharePointSource. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SharePointSourcesSharePointSource { + /** + * The Application ID for the app registered in Microsoft Azure Portal. The application must also be configured with MS Graph permissions "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All. + */ + clientId?: string | null; + /** + * The application secret for the app registered in Azure. + */ + clientSecret?: Schema$GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig; + /** + * The ID of the drive to download from. + */ + driveId?: string | null; + /** + * The name of the drive to download from. + */ + driveName?: string | null; + /** + * Output only. The SharePoint file id. Output only. + */ + fileId?: string | null; + /** + * The ID of the SharePoint folder to download from. + */ + sharepointFolderId?: string | null; + /** + * The path of the SharePoint folder to download from. + */ + sharepointFolderPath?: string | null; + /** + * The name of the SharePoint site to download from. This can be the site name or the site id. + */ + sharepointSiteName?: string | null; + /** + * Unique identifier of the Azure Active Directory Instance. + */ + tenantId?: string | null; + } /** * A set of Shielded Instance options. See [Images using supported Shielded VM features](https://cloud.google.com/compute/docs/instances/modifying-shielded-vm). */ @@ -16702,7 +17327,7 @@ export namespace aiplatform_v1beta1 { userOutputTokenDistribution?: Schema$GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution; } /** - * Tuning Spec for Supervised Tuning. + * Tuning Spec for Supervised Tuning for first party models. */ export interface Schema$GoogleCloudAiplatformV1beta1SupervisedTuningSpec { /** @@ -16723,7 +17348,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest {} /** - * Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + * Response message for FeatureOnlineStoreAdminService.SyncFeatureView. */ export interface Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewResponse { /** @@ -17121,7 +17746,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1Tool { /** - * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ functionDeclarations?: Schema$GoogleCloudAiplatformV1beta1FunctionDeclaration[]; /** @@ -17556,6 +18181,23 @@ export namespace aiplatform_v1beta1 { */ model?: string | null; } + /** + * TunedModel Reference for legacy model migration. + */ + export interface Schema$GoogleCloudAiplatformV1beta1TunedModelRef { + /** + * Support migration from tuning job list page, from bison model to gemini model. + */ + pipelineJob?: string | null; + /** + * Support migration from model registry. + */ + tunedModel?: string | null; + /** + * Support migration from tuning job list page, from gemini-1.0-pro-002 to 1.5 and above. + */ + tuningJob?: string | null; + } /** * The tuning data statistic values for TuningJob. */ @@ -20567,6 +21209,200 @@ export namespace aiplatform_v1beta1 { ); } + /** + * Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded 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. + */ + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + options: StreamMethodOptions + ): GaxiosPromise; + augmentPrompt( + params?: Params$Resource$Projects$Locations$Augmentprompt, + options?: MethodOptions + ): GaxiosPromise; + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + augmentPrompt( + params: Params$Resource$Projects$Locations$Augmentprompt, + callback: BodyResponseCallback + ): void; + augmentPrompt( + callback: BodyResponseCallback + ): void; + augmentPrompt( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Augmentprompt + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Augmentprompt; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Augmentprompt; + 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}:augmentPrompt').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 + ); + } + } + + /** + * Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + options: StreamMethodOptions + ): GaxiosPromise; + corroborateContent( + params?: Params$Resource$Projects$Locations$Corroboratecontent, + options?: MethodOptions + ): GaxiosPromise; + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + corroborateContent( + params: Params$Resource$Projects$Locations$Corroboratecontent, + callback: BodyResponseCallback + ): void; + corroborateContent( + callback: BodyResponseCallback + ): void; + corroborateContent( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Corroboratecontent + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Corroboratecontent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Corroboratecontent; + 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}:corroborateContent').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 + ); + } + } + /** * Evaluates instances based on a given metric. * @@ -20951,6 +21787,30 @@ export namespace aiplatform_v1beta1 { } } + export interface Params$Resource$Projects$Locations$Augmentprompt + extends StandardParameters { + /** + * Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1AugmentPromptRequest; + } + export interface Params$Resource$Projects$Locations$Corroboratecontent + extends StandardParameters { + /** + * Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1CorroborateContentRequest; + } export interface Params$Resource$Projects$Locations$Evaluateinstances extends StandardParameters { /** @@ -27047,7 +27907,7 @@ export namespace aiplatform_v1beta1 { } /** - * Lists Annotations belongs to a dataitem + * Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -38229,7 +39089,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Featuregroups$Create 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 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. + * 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; /** @@ -46252,7 +47112,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Batchcreate extends StandardParameters { /** - * Required. The resource name of the EntityType to create the batch of Features under. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * 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; @@ -73943,6 +74803,98 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * 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. + */ + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Ragcorpora$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Ragcorpora$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Ragcorpora$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Ragcorpora$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Ragcorpora$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$Ragcorpora$Create @@ -73990,6 +74942,18 @@ export namespace aiplatform_v1beta1 { */ 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; @@ -88568,8 +89532,12 @@ export namespace aiplatform_v1beta1 { export class Resource$Projects$Locations$Tuningjobs { context: APIRequestContext; + operations: Resource$Projects$Locations$Tuningjobs$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = new Resource$Projects$Locations$Tuningjobs$Operations( + this.context + ); } /** @@ -88950,6 +89918,101 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Rebase a TunedModel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: StreamMethodOptions + ): GaxiosPromise; + rebaseTunedModel( + params?: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options?: MethodOptions + ): GaxiosPromise; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + params: Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel, + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + callback: BodyResponseCallback + ): void; + rebaseTunedModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel; + 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}/tuningJobs:rebaseTunedModel' + ).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$Tuningjobs$Cancel @@ -89002,6 +90065,122 @@ export namespace aiplatform_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Tuningjobs$Rebasetunedmodel + extends StandardParameters { + /** + * Required. The resource name of the Location into which to rebase the Model. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1RebaseTunedModelRequest; + } + + export class Resource$Projects$Locations$Tuningjobs$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. + */ + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Tuningjobs$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); + } + } + } + + export interface Params$Resource$Projects$Locations$Tuningjobs$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } export class Resource$Publishers { context: APIRequestContext; diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index 102af0c757..716241b5b4 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -289,7 +289,7 @@ export namespace alloydb_v1 { */ requireConnectors?: boolean | null; /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. */ sslConfig?: Schema$SslConfig; } @@ -568,11 +568,11 @@ export namespace alloydb_v1 { */ export interface Schema$FailoverInstanceRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -644,11 +644,11 @@ export namespace alloydb_v1 { */ faultType?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -713,13 +713,17 @@ export namespace alloydb_v1 { */ name?: string | null; /** - * Optional. Instance level network configuration. + * Optional. Instance-level network configuration. */ networkConfig?: Schema$InstanceNetworkConfig; /** * Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance. */ nodes?: Schema$Node[]; + /** + * Output only. All outbound public IP addresses configured for the instance. + */ + outboundPublicIpAddresses?: string[] | null; /** * Optional. The configuration for Private Service Connect (PSC) for the instance. */ @@ -762,13 +766,17 @@ export namespace alloydb_v1 { writableNode?: Schema$Node; } /** - * Metadata related to instance level network configuration. + * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { /** * Optional. A list of external network authorized to access this instance. */ authorizedExternalNetworks?: Schema$AuthorizedNetwork[]; + /** + * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. + */ + enableOutboundPublicIp?: boolean | null; /** * Optional. Enabling public ip for the instance. */ @@ -1065,11 +1073,11 @@ export namespace alloydb_v1 { */ etag?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1153,15 +1161,15 @@ export namespace alloydb_v1 { } export interface Schema$RestartInstanceRequest { /** - * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. */ nodeIds?: string[] | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1186,11 +1194,11 @@ export namespace alloydb_v1 { */ continuousBackupSource?: Schema$ContinuousBackupSource; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1430,7 +1438,7 @@ export namespace alloydb_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. + * Common model for database resource instance metadata. Next ID: 22 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1485,6 +1493,10 @@ export namespace alloydb_v1 { * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceLocation?: string | null; /** * The product this resource represents. */ @@ -1497,6 +1509,10 @@ export namespace alloydb_v1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Tags associated with this resources. + */ + tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags; /** * The time at which the resource was updated and recorded at partner service. */ @@ -1587,6 +1603,10 @@ export namespace alloydb_v1 { * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; + /** + * Optional. Number of shards (if applicable). + */ + shardCount?: number | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData { /** @@ -1625,6 +1645,10 @@ export namespace alloydb_v1 { message?: string | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings { + /** + * Duration based retention period i.e. 172800 seconds (2 days) + */ + durationBasedRetention?: string | null; quantityBasedRetention?: number | null; /** * The unit that 'retained_backups' represents. @@ -1632,6 +1656,15 @@ export namespace alloydb_v1 { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainTags { + /** + * The Tag key/value mappings. + */ + tags?: {[key: string]: string} | null; + } /** * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. */ @@ -1724,11 +1757,11 @@ export namespace alloydb_v1 { */ export interface Schema$SwitchoverClusterRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1762,6 +1795,27 @@ export namespace alloydb_v1 { */ upgradeTime?: string | null; } + /** + * Upgrades a cluster. + */ + export interface Schema$UpgradeClusterRequest { + /** + * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned. + */ + etag?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. + */ + validateOnly?: boolean | null; + /** + * Required. The version the cluster is going to be upgraded to. + */ + version?: string | null; + } /** * UpgradeClusterResponse contains the response for upgrade cluster operation. */ @@ -2526,7 +2580,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2550,7 +2604,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2599,7 +2653,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3331,7 +3385,7 @@ export namespace alloydb_v1 { } /** - * Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster. + * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3417,6 +3471,94 @@ export namespace alloydb_v1 { return createAPIRequest(parameters); } } + + /** + * Upgrades a single Cluster. Imperative only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions + ): GaxiosPromise; + upgrade( + params?: Params$Resource$Projects$Locations$Clusters$Upgrade, + options?: MethodOptions + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + callback: BodyResponseCallback + ): void; + upgrade(callback: BodyResponseCallback): void; + upgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Upgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Upgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Clusters$Create @@ -3430,11 +3572,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3454,11 +3596,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3482,11 +3624,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -3535,7 +3677,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3543,7 +3685,7 @@ export namespace alloydb_v1 { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3588,6 +3730,18 @@ export namespace alloydb_v1 { */ requestBody?: Schema$SwitchoverClusterRequest; } + export interface Params$Resource$Projects$Locations$Clusters$Upgrade + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpgradeClusterRequest; + } export class Resource$Projects$Locations$Clusters$Instances { context: APIRequestContext; @@ -4495,11 +4649,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4519,11 +4673,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4543,11 +4697,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -4581,7 +4735,7 @@ export namespace alloydb_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 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -4631,7 +4785,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -4639,7 +4793,7 @@ export namespace alloydb_v1 { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -5109,7 +5263,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5133,7 +5287,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5182,7 +5336,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 8afc11bf09..2481affaa8 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -293,7 +293,7 @@ export namespace alloydb_v1alpha { */ requireConnectors?: boolean | null; /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. */ sslConfig?: Schema$SslConfig; } @@ -609,11 +609,11 @@ export namespace alloydb_v1alpha { */ export interface Schema$FailoverInstanceRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -703,11 +703,11 @@ export namespace alloydb_v1alpha { */ faultType?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -776,7 +776,7 @@ export namespace alloydb_v1alpha { */ name?: string | null; /** - * Optional. Instance level network configuration. + * Optional. Instance-level network configuration. */ networkConfig?: Schema$InstanceNetworkConfig; /** @@ -841,7 +841,7 @@ export namespace alloydb_v1alpha { writableNode?: Schema$Node; } /** - * Metadata related to instance level network configuration. + * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { /** @@ -1189,11 +1189,11 @@ export namespace alloydb_v1alpha { */ etag?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1277,15 +1277,15 @@ export namespace alloydb_v1alpha { } export interface Schema$RestartInstanceRequest { /** - * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. */ nodeIds?: string[] | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1310,11 +1310,11 @@ export namespace alloydb_v1alpha { */ continuousBackupSource?: Schema$ContinuousBackupSource; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1554,7 +1554,7 @@ export namespace alloydb_v1alpha { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. + * Common model for database resource instance metadata. Next ID: 22 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1609,6 +1609,10 @@ export namespace alloydb_v1alpha { * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceLocation?: string | null; /** * The product this resource represents. */ @@ -1621,6 +1625,10 @@ export namespace alloydb_v1alpha { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Tags associated with this resources. + */ + tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags; /** * The time at which the resource was updated and recorded at partner service. */ @@ -1711,6 +1719,10 @@ export namespace alloydb_v1alpha { * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; + /** + * Optional. Number of shards (if applicable). + */ + shardCount?: number | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData { /** @@ -1749,6 +1761,10 @@ export namespace alloydb_v1alpha { message?: string | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings { + /** + * Duration based retention period i.e. 172800 seconds (2 days) + */ + durationBasedRetention?: string | null; quantityBasedRetention?: number | null; /** * The unit that 'retained_backups' represents. @@ -1756,6 +1772,15 @@ export namespace alloydb_v1alpha { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainTags { + /** + * The Tag key/value mappings. + */ + tags?: {[key: string]: string} | null; + } /** * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. */ @@ -1848,11 +1873,11 @@ export namespace alloydb_v1alpha { */ export interface Schema$SwitchoverClusterRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1904,11 +1929,11 @@ export namespace alloydb_v1alpha { */ etag?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; /** @@ -2680,7 +2705,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2704,7 +2729,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2753,7 +2778,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3484,7 +3509,7 @@ export namespace alloydb_v1alpha { } /** - * Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster. + * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3671,11 +3696,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3695,11 +3720,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3723,11 +3748,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -3776,7 +3801,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3784,7 +3809,7 @@ export namespace alloydb_v1alpha { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4747,11 +4772,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4771,11 +4796,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4795,11 +4820,11 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -4833,7 +4858,7 @@ export namespace alloydb_v1alpha { */ 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 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -4883,7 +4908,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -4891,7 +4916,7 @@ export namespace alloydb_v1alpha { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -5361,7 +5386,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5385,7 +5410,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5434,7 +5459,7 @@ export namespace alloydb_v1alpha { */ 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 71e155e39c..afc7214414 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -285,7 +285,7 @@ export namespace alloydb_v1beta { */ requireConnectors?: boolean | null; /** - * Optional. SSL config option for this instance. + * Optional. SSL configuration option for this instance. */ sslConfig?: Schema$SslConfig; } @@ -597,11 +597,11 @@ export namespace alloydb_v1beta { */ export interface Schema$FailoverInstanceRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the failover. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -691,11 +691,11 @@ export namespace alloydb_v1beta { */ faultType?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the fault injection. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -764,7 +764,7 @@ export namespace alloydb_v1beta { */ name?: string | null; /** - * Optional. Instance level network configuration. + * Optional. Instance-level network configuration. */ networkConfig?: Schema$InstanceNetworkConfig; /** @@ -825,7 +825,7 @@ export namespace alloydb_v1beta { writableNode?: Schema$Node; } /** - * Metadata related to instance level network configuration. + * Metadata related to instance-level network configuration. */ export interface Schema$InstanceNetworkConfig { /** @@ -1173,11 +1173,11 @@ export namespace alloydb_v1beta { */ etag?: string | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1261,15 +1261,15 @@ export namespace alloydb_v1beta { } export interface Schema$RestartInstanceRequest { /** - * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Applicable only to read instances. */ nodeIds?: string[] | null; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the restart. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1294,11 +1294,11 @@ export namespace alloydb_v1beta { */ continuousBackupSource?: Schema$ContinuousBackupSource; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the import request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1538,7 +1538,7 @@ export namespace alloydb_v1beta { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. + * Common model for database resource instance metadata. Next ID: 22 */ export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata { /** @@ -1593,6 +1593,10 @@ export namespace alloydb_v1beta { * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceLocation?: string | null; /** * The product this resource represents. */ @@ -1605,6 +1609,10 @@ export namespace alloydb_v1beta { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Tags associated with this resources. + */ + tagsSet?: Schema$StorageDatabasecenterPartnerapiV1mainTags; /** * The time at which the resource was updated and recorded at partner service. */ @@ -1695,6 +1703,10 @@ export namespace alloydb_v1beta { * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; + /** + * Optional. Number of shards (if applicable). + */ + shardCount?: number | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData { /** @@ -1733,6 +1745,10 @@ export namespace alloydb_v1beta { message?: string | null; } export interface Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings { + /** + * Duration based retention period i.e. 172800 seconds (2 days) + */ + durationBasedRetention?: string | null; quantityBasedRetention?: number | null; /** * The unit that 'retained_backups' represents. @@ -1740,6 +1756,15 @@ export namespace alloydb_v1beta { retentionUnit?: string | null; timeBasedRetention?: string | null; } + /** + * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainTags { + /** + * The Tag key/value mappings. + */ + tags?: {[key: string]: string} | null; + } /** * Message type for storing user labels. User labels are used to tag App Engine resources, allowing users to search for resources matching a set of labels and to aggregate usage data by labels. */ @@ -1832,11 +1857,11 @@ export namespace alloydb_v1beta { */ export interface Schema$SwitchoverClusterRequest { /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean | null; } @@ -1879,6 +1904,27 @@ export namespace alloydb_v1beta { */ mode?: string | null; } + /** + * Upgrades a cluster. + */ + export interface Schema$UpgradeClusterRequest { + /** + * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned. + */ + etag?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. + */ + validateOnly?: boolean | null; + /** + * Required. The version the cluster is going to be upgraded to. + */ + version?: string | null; + } /** * UpgradeClusterResponse contains the response for upgrade cluster operation. */ @@ -2643,7 +2689,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2667,7 +2713,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2716,7 +2762,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3447,7 +3493,7 @@ export namespace alloydb_v1beta { } /** - * Switches the role of PRIMARY and SECONDARY cluster without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up original PRIMARY cluster to replicate from this newly promoted cluster. + * Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted cluster. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3533,6 +3579,94 @@ export namespace alloydb_v1beta { return createAPIRequest(parameters); } } + + /** + * Upgrades a single Cluster. Imperative only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions + ): GaxiosPromise; + upgrade( + params?: Params$Resource$Projects$Locations$Clusters$Upgrade, + options?: MethodOptions + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + callback: BodyResponseCallback + ): void; + upgrade(callback: BodyResponseCallback): void; + upgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Upgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Upgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Clusters$Create @@ -3546,11 +3680,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3570,11 +3704,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3598,11 +3732,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -3651,7 +3785,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -3659,7 +3793,7 @@ export namespace alloydb_v1beta { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -3704,6 +3838,18 @@ export namespace alloydb_v1beta { */ requestBody?: Schema$SwitchoverClusterRequest; } + export interface Params$Resource$Projects$Locations$Clusters$Upgrade + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpgradeClusterRequest; + } export class Resource$Projects$Locations$Clusters$Instances { context: APIRequestContext; @@ -4610,11 +4756,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4634,11 +4780,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -4658,11 +4804,11 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the delete. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; } @@ -4696,7 +4842,7 @@ export namespace alloydb_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 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. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -4746,7 +4892,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -4754,7 +4900,7 @@ export namespace alloydb_v1beta { */ updateMask?: string; /** - * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the update request. + * Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request. */ validateOnly?: boolean; @@ -5224,7 +5370,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5248,7 +5394,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -5297,7 +5443,7 @@ export namespace alloydb_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 the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating 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 ignores the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if the original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 41488c0d07..2ca97e0340 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -905,7 +905,7 @@ export namespace analyticsadmin_v1alpha { */ name?: string | null; /** - * Immutable. The linked Google Cloud project resource name. Currently, this API always uses a project number, but may use project IDs in the future. Format: 'projects/{project number\}' Example: 'projects/1234' + * Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: 'projects/{project number\}' Example: 'projects/1234' */ project?: string | null; /** @@ -3517,7 +3517,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). + * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6480,7 +6480,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). + * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/analyticsadmin/v1beta.ts b/src/apis/analyticsadmin/v1beta.ts index cad4d45fd6..4a004e2223 100644 --- a/src/apis/analyticsadmin/v1beta.ts +++ b/src/apis/analyticsadmin/v1beta.ts @@ -1864,7 +1864,7 @@ export namespace analyticsadmin_v1beta { } /** - * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). + * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2947,7 +2947,7 @@ export namespace analyticsadmin_v1beta { } /** - * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). + * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index d4e565d809..411ce384a7 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -526,7 +526,7 @@ export namespace analyticshub_v1 { */ labels?: {[key: string]: string} | null; /** - * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. + * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. */ messageRetentionDuration?: string | null; /** diff --git a/src/apis/androiddeviceprovisioning/v1.ts b/src/apis/androiddeviceprovisioning/v1.ts index 5a8ac64d73..e9b4b01b6d 100644 --- a/src/apis/androiddeviceprovisioning/v1.ts +++ b/src/apis/androiddeviceprovisioning/v1.ts @@ -439,6 +439,10 @@ export namespace androiddeviceprovisioning_v1 { * The device’s IMEI number. Validated on input. */ imei?: string | null; + /** + * The device’s second IMEI number. + */ + imei2?: string | null; /** * The device manufacturer’s name. Matches the device's built-in value returned from `android.os.Build.MANUFACTURER`. Allowed values are listed in [Android manufacturers](/zero-touch/resources/manufacturer-names#manufacturers-names). */ @@ -447,6 +451,10 @@ export namespace androiddeviceprovisioning_v1 { * The device’s MEID number. */ meid?: string | null; + /** + * The device’s second MEID number. + */ + meid2?: string | null; /** * The device model's name. Allowed values are listed in [Android models](/zero-touch/resources/manufacturer-names#model-names) and [Chrome OS models](https://support.google.com/chrome/a/answer/10130175#identify_compatible). */ diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 78f68420e7..4462554679 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -146,9 +146,13 @@ export namespace androidmanagement_v1 { */ export interface Schema$AdvancedSecurityOverrides { /** - * Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + * Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. */ commonCriteriaMode?: string | null; + /** + * Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. + */ + contentProtectionPolicy?: string | null; /** * Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). */ @@ -715,6 +719,10 @@ export namespace androidmanagement_v1 { * Whether Common Criteria Mode is enabled. */ commonCriteriaModeStatus?: string | null; + /** + * Output only. The status of policy signature verification. + */ + policySignatureVerificationStatus?: string | null; } /** * A rule declaring which mitigating actions to take when a device is not compliant with its policy. For every rule, there is always an implicit mitigating action to set policy_compliant to false for the Device resource, and display a message on the device indicating that the device is not compliant with its policy. Other mitigating actions may optionally be taken as well, depending on the field values in the rule. @@ -1024,6 +1032,10 @@ export namespace androidmanagement_v1 { * Controls configuring and using Wi-Fi direct settings. Supported on company-owned devices running Android 13 and above. */ wifiDirectSettings?: string | null; + /** + * Optional. Wi-Fi roaming policy. + */ + wifiRoamingPolicy?: Schema$WifiRoamingPolicy; /** * Restrictions on which Wi-Fi SSIDs the device can connect to. Note that this does not affect which networks can be configured on the device. Supported on company-owned devices running Android 13 and above. */ @@ -2722,7 +2734,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$ScreenBrightnessSettings { /** - * Optional. The screen brightness between 1 and 255 where 1 is the lowest and 255 is the highest brightness. A value of 0 (default) means no screen brightness set. Any other value is rejected. screenBrightnessMode must be either BRIGHTNESS_AUTOMATIC or BRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. + * Optional. The screen brightness between 1 and 255 where 1 is the lowest and 255 is the highest brightness. A value of 0 (default) means no screen brightness set. Any other value is rejected. screenBrightnessMode must be either BRIGHTNESS_AUTOMATIC or BRIGHTNESS_FIXED to set this. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above. */ screenBrightness?: number | null; /** @@ -2735,7 +2747,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$ScreenTimeoutSettings { /** - * Optional. Controls the screen timeout duration. The screen timeout duration must be greater than 0, otherwise it is rejected. Additionally, it should not be greater than maximumTimeToLock, otherwise the screen timeout is set to maximumTimeToLock and a NonComplianceDetail with INVALID_VALUE reason and SCREEN_TIMEOUT_GREATER_THAN_MAXIMUM_TIME_TO_LOCK specific reason is reported. If the screen timeout is less than a certain lower bound, it is set to the lower bound. The lower bound may vary across devices. If this is set, screenTimeoutMode must be SCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. + * Optional. Controls the screen timeout duration. The screen timeout duration must be greater than 0, otherwise it is rejected. Additionally, it should not be greater than maximumTimeToLock, otherwise the screen timeout is set to maximumTimeToLock and a NonComplianceDetail with INVALID_VALUE reason and SCREEN_TIMEOUT_GREATER_THAN_MAXIMUM_TIME_TO_LOCK specific reason is reported. If the screen timeout is less than a certain lower bound, it is set to the lower bound. The lower bound may vary across devices. If this is set, screenTimeoutMode must be SCREEN_TIMEOUT_ENFORCED. Supported on Android 9 and above on fully managed devices. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 9. Supported on work profiles on company-owned devices on Android 15 and above. */ screenTimeout?: string | null; /** @@ -3302,6 +3314,28 @@ export namespace androidmanagement_v1 { */ value?: string | null; } + /** + * Wi-Fi roaming policy. + */ + export interface Schema$WifiRoamingPolicy { + /** + * Optional. Wi-Fi roaming settings. SSIDs provided in this list must be unique, the policy will be rejected otherwise. + */ + wifiRoamingSettings?: Schema$WifiRoamingSetting[]; + } + /** + * Wi-Fi roaming setting. + */ + export interface Schema$WifiRoamingSetting { + /** + * Required. Wi-Fi roaming mode for the specified SSID. + */ + wifiRoamingMode?: string | null; + /** + * Required. SSID of the Wi-Fi network. + */ + wifiSsid?: string | null; + } /** * Represents a Wi-Fi SSID. */ diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 6a32f82e0f..3a35d7962e 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -521,7 +521,7 @@ export namespace androidpublisher_v3 { */ accountHoldDuration?: string | null; /** - * Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + * Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created. */ billingPeriodDuration?: string | null; /** @@ -1273,15 +1273,6 @@ export namespace androidpublisher_v3 { */ versionName?: string | null; } - /** - * Details about the first time a user/device completed a transaction using external offers. - */ - export interface Schema$ExternalOfferInitialAcquisitionDetails { - /** - * Required. The external transaction id of the first completed purchase made by the user. - */ - externalTransactionId?: string | null; - } /** * Details of an external subscription. */ @@ -1307,10 +1298,6 @@ export namespace androidpublisher_v3 { * Output only. The current tax amount. This represents the current tax amount including any refunds that may have been applied to this transaction. */ currentTaxAmount?: Schema$Price; - /** - * Optional. Details about the first time a user/device completed a transaction using external offers. Not required for transactions made using user choice billing or alternative billing only. - */ - externalOfferInitialAcquisitionDetails?: Schema$ExternalOfferInitialAcquisitionDetails; /** * Output only. The id of this transaction. All transaction ids under the same package name must be unique. Set when creating the external transaction. */ @@ -1797,11 +1784,11 @@ export namespace androidpublisher_v3 { */ accountHoldDuration?: string | null; /** - * Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + * Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created. */ billingPeriodDuration?: string | null; /** - * Required. The number of payments the user is committed to. + * Required. Immutable. The number of payments the user is committed to. It is immutable after the base plan is created. */ committedPaymentsCount?: number | null; /** @@ -1813,7 +1800,7 @@ export namespace androidpublisher_v3 { */ prorationMode?: string | null; /** - * Required. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. + * Required. Immutable. Installments base plan renewal type. Determines the behavior at the end of the initial commitment. The renewal type is immutable after the base plan is created. */ renewalType?: string | null; /** @@ -2268,7 +2255,7 @@ export namespace androidpublisher_v3 { */ export interface Schema$PrepaidBasePlanType { /** - * Required. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. + * Required. Immutable. Subscription period, specified in ISO 8601 format. For a list of acceptable billing periods, refer to the help center. The duration is immutable after the base plan is created. */ billingPeriodDuration?: string | null; /** @@ -2923,7 +2910,7 @@ export namespace androidpublisher_v3 { */ packageName?: string | null; /** - * Required. The phases of this subscription offer. Must contain at least one entry, and may contain at most five. Users will always receive all these phases in the specified order. Phases may not be added, removed, or reordered after initial creation. + * Required. The phases of this subscription offer. Must contain at least one and at most two entries. Users will always receive all these phases in the specified order. */ phases?: Schema$SubscriptionOfferPhase[]; /** diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 6f4d784056..4ceae0106f 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -661,6 +661,19 @@ export namespace appengine_v1 { */ runtimeVersion?: string | null; } + /** + * For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info. + */ + export interface Schema$GceTag { + /** + * The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported. + */ + parent?: string[] | null; + /** + * The administrative_tag name. + */ + tag?: string | null; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -1268,6 +1281,10 @@ export namespace appengine_v1 { * The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel. */ consumerProjectState?: string | null; + /** + * The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE. + */ + gceTag?: Schema$GceTag[]; /** * The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH. */ diff --git a/src/apis/appengine/v1alpha.ts b/src/apis/appengine/v1alpha.ts index 8d8873a4b6..3abea33bcc 100644 --- a/src/apis/appengine/v1alpha.ts +++ b/src/apis/appengine/v1alpha.ts @@ -259,6 +259,19 @@ export namespace appengine_v1alpha { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info. + */ + export interface Schema$GceTag { + /** + * The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported. + */ + parent?: string[] | null; + /** + * The administrative_tag name. + */ + tag?: string | null; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -560,6 +573,10 @@ export namespace appengine_v1alpha { * The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel. */ consumerProjectState?: string | null; + /** + * The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE. + */ + gceTag?: Schema$GceTag[]; /** * The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH. */ diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 96da6cd4e1..cc94b60f3f 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -703,6 +703,19 @@ export namespace appengine_v1beta { */ runtimeVersion?: string | null; } + /** + * For use only by GCE. GceTag is a wrapper around the GCE administrative tag with parent info. + */ + export interface Schema$GceTag { + /** + * The parents(s) of the tag. Eg. projects/123, folders/456 It usually contains only one parent. But, in some corner cases, it can contain multiple parents. Currently, organizations are not supported. + */ + parent?: string[] | null; + /** + * The administrative_tag name. + */ + tag?: string | null; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -1310,6 +1323,10 @@ export namespace appengine_v1beta { * The CCFE state of the consumer project. It is the same state that is communicated to the CLH during project events. Notice that this field is not set in the DB, it is only set in this proto when communicated to CLH in the side channel. */ consumerProjectState?: string | null; + /** + * The GCE tags associated with the consumer project and those inherited due to their ancestry, if any. Not supported by CCFE. + */ + gceTag?: Schema$GceTag[]; /** * The service account authorized to operate on the consumer project. Note: CCFE only propagates P4SA with default tag to CLH. */ diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index f56f675a98..7d14095920 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -166,6 +166,47 @@ export namespace artifactregistry_v1 { */ publicRepository?: Schema$GoogleDevtoolsArtifactregistryV1RemoteRepositoryConfigAptRepositoryPublicRepository; } + /** + * An Attachment refers to additional metadata that can be attached to artifacts in Artifact Registry. An attachment consists of one or more files. + */ + export interface Schema$Attachment { + /** + * Optional. User annotations. These attributes can only be set and used by the user, and not by Artifact Registry. See https://google.aip.dev/128#annotations for more details such as format and size limitations. + */ + annotations?: {[key: string]: string} | null; + /** + * The namespace this attachment belongs to. E.g. If an Attachment is created by artifact analysis, namespace is set to `artifactanalysis.googleapis.com`. + */ + attachmentNamespace?: string | null; + /** + * Output only. The time when the attachment was created. + */ + createTime?: string | null; + /** + * Required. The files that belong to this attachment. If the file ID part contains slashes, they are escaped. E.g. `projects/p1/locations/us-central1/repositories/repo1/files/sha:`. + */ + files?: string[] | null; + /** + * The name of the attachment. E.g. "projects/p1/locations/us/repositories/repo/attachments/sbom". + */ + name?: string | null; + /** + * Output only. The name of the OCI version that this attachment created. Only populated for Docker attachments. E.g. `projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1`. + */ + ociVersionName?: string | null; + /** + * Required. The target the attachment is for, can be a Version, Package or Repository. E.g. "projects/p1/locations/us-central1/repositories/repo1/packages/p1/versions/v1". + */ + target?: string | null; + /** + * Type of Attachment. E.g. `application/vnd.spdx+json` + */ + type?: string | null; + /** + * Output only. The time when the attachment was last updated. + */ + updateTime?: string | null; + } /** * The metadata of an LRO from deleting multiple versions. */ @@ -268,6 +309,15 @@ export namespace artifactregistry_v1 { */ packageNamePrefixes?: string[] | null; } + /** + * Common remote repository settings type. + */ + export interface Schema$CommonRemoteRepository { + /** + * Required. A common public repository base for remote repository. + */ + uri?: string | null; + } /** * DockerImage represents a docker artifact. The following fields are returned as untyped metadata in the Version resource, using camelcase keys (i.e. metadata.imageSizeBytes): * imageSizeBytes * mediaType * buildTime */ @@ -419,6 +469,10 @@ export namespace artifactregistry_v1 { * Files store content that is potentially associated with Packages or Versions. */ export interface Schema$GoogleDevtoolsArtifactregistryV1File { + /** + * Optional. Client specified annotations. + */ + annotations?: {[key: string]: string} | null; /** * Output only. The time when the File was created. */ @@ -528,6 +582,28 @@ export namespace artifactregistry_v1 { */ repositoryPath?: string | null; } + /** + * A Rule applies to repository or package level. It defines the deny or allow action of the operation when the conditions in the rule are met. + */ + export interface Schema$GoogleDevtoolsArtifactregistryV1Rule { + /** + * The action this rule makes. + */ + action?: string | null; + /** + * Optional. The condition of the rule in CEL expression. If not provided, the rule matches all the objects. + */ + condition?: Schema$Expr; + /** + * The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + */ + name?: string | null; + operation?: string | null; + /** + * The package ID the rule applies to. If empty, this rule applies to all the packages inside the repository. + */ + packageId?: string | null; + } /** * A hash of file content. */ @@ -710,6 +786,19 @@ export namespace artifactregistry_v1 { */ version?: string | null; } + /** + * The response from listing attachments. + */ + export interface Schema$ListAttachmentsResponse { + /** + * The Attachments returned. + */ + attachments?: Schema$Attachment[]; + /** + * The token to retrieve the next page of attachments, or empty if there are no more attachments to return. + */ + nextPageToken?: string | null; + } /** * The response from listing docker images. */ @@ -814,6 +903,19 @@ export namespace artifactregistry_v1 { */ repositories?: Schema$Repository[]; } + /** + * The response from listing rules. + */ + export interface Schema$ListRulesResponse { + /** + * The token to retrieve the next page of rules, or empty if there are no more rules to return. + */ + nextPageToken?: string | null; + /** + * The rules returned. + */ + rules?: Schema$GoogleDevtoolsArtifactregistryV1Rule[]; + } /** * The response from listing tags. */ @@ -1054,10 +1156,6 @@ export namespace artifactregistry_v1 { */ pullPercent?: number | null; } - /** - * The metadata for promote artifact long running operation. - */ - export interface Schema$PromoteArtifactMetadata {} /** * PythonPackage represents a python artifact. */ @@ -1108,6 +1206,10 @@ export namespace artifactregistry_v1 { * Specific settings for an Apt remote repository. */ aptRepository?: Schema$AptRepository; + /** + * Common remote repository settings. Used as the RemoteRepository upstream URL instead of Predefined and Custom remote repositories. Google Cloud Console and Google Cloud CLI will map all the new remote repositories to this field. + */ + commonRepository?: Schema$CommonRemoteRepository; /** * The description of the remote source. */ @@ -1301,6 +1403,24 @@ export namespace artifactregistry_v1 { */ aptArtifacts?: Schema$AptArtifact[]; } + /** + * The response to upload a generic artifact. + */ + export interface Schema$UploadFileMediaResponse { + /** + * Operation that will be returned to the user. + */ + operation?: Schema$Operation; + } + /** + * The request to upload a file. + */ + export interface Schema$UploadFileRequest { + /** + * Optional. The ID of the file. If left empty will default to sha256 digest of the content uploaded. + */ + fileId?: string | null; + } /** * The response to upload a generic artifact. */ @@ -1469,6 +1589,10 @@ export namespace artifactregistry_v1 { * The body of a version resource. A version resource represents a collection of components, such as files and other data. This may correspond to a version in many package management schemes. */ export interface Schema$Version { + /** + * Optional. Client specified annotations. + */ + annotations?: {[key: string]: string} | null; /** * The time when the version was created. */ @@ -1482,7 +1606,7 @@ export namespace artifactregistry_v1 { */ metadata?: {[key: string]: any} | null; /** - * The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". If the package or version ID parts contain slashes, the slashes are escaped. + * The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped. */ name?: string | null; /** @@ -2281,6 +2405,7 @@ export namespace artifactregistry_v1 { export class Resource$Projects$Locations$Repositories { context: APIRequestContext; aptArtifacts: Resource$Projects$Locations$Repositories$Aptartifacts; + attachments: Resource$Projects$Locations$Repositories$Attachments; dockerImages: Resource$Projects$Locations$Repositories$Dockerimages; files: Resource$Projects$Locations$Repositories$Files; genericArtifacts: Resource$Projects$Locations$Repositories$Genericartifacts; @@ -2291,11 +2416,14 @@ export namespace artifactregistry_v1 { npmPackages: Resource$Projects$Locations$Repositories$Npmpackages; packages: Resource$Projects$Locations$Repositories$Packages; pythonPackages: Resource$Projects$Locations$Repositories$Pythonpackages; + rules: Resource$Projects$Locations$Repositories$Rules; yumArtifacts: Resource$Projects$Locations$Repositories$Yumartifacts; constructor(context: APIRequestContext) { this.context = context; this.aptArtifacts = new Resource$Projects$Locations$Repositories$Aptartifacts(this.context); + this.attachments = + new Resource$Projects$Locations$Repositories$Attachments(this.context); this.dockerImages = new Resource$Projects$Locations$Repositories$Dockerimages(this.context); this.files = new Resource$Projects$Locations$Repositories$Files( @@ -2327,6 +2455,9 @@ export namespace artifactregistry_v1 { new Resource$Projects$Locations$Repositories$Pythonpackages( this.context ); + this.rules = new Resource$Projects$Locations$Repositories$Rules( + this.context + ); this.yumArtifacts = new Resource$Projects$Locations$Repositories$Yumartifacts(this.context); } @@ -3094,7 +3225,7 @@ export namespace artifactregistry_v1 { export interface Params$Resource$Projects$Locations$Repositories$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name "my-repo" in project my-project in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-*"` * `name="projects/my-project/locations/us-central1/repositories/xrepo"` * `name="projects/my-project/locations/us-central1/repositories/xrepo*"` + * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` Examples of using a filter: To filter the results of your request to repositories with the name `my-repo` in project `my-project` in the `us-central` region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-*"` * `name="projects/my-project/locations/us-central1/repositories/xrepo"` * `name="projects/my-project/locations/us-central1/repositories/xrepo*"` */ filter?: string; /** @@ -3394,65 +3525,65 @@ export namespace artifactregistry_v1 { }; } - export class Resource$Projects$Locations$Repositories$Dockerimages { + export class Resource$Projects$Locations$Repositories$Attachments { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a docker image. + * Creates an attachment. The returned Operation will finish once the attachment has been created. Its response will be the created attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Dockerimages$Get, + create( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, + create( + params?: Params$Resource$Projects$Locations$Repositories$Attachments$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Dockerimages$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Attachments$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$Repositories$Dockerimages$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Attachments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Dockerimages$Get; + {} as Params$Resource$Projects$Locations$Repositories$Attachments$Create; options = {}; } @@ -3466,85 +3597,83 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/attachments').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 docker images. + * Deletes an attachment. The returned Operation will finish once the attachments has been deleted. It will not have any Operation metadata and will return a `google.protobuf.Empty` 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$Repositories$Dockerimages$List, + delete( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Attachments$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Dockerimages$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Attachments$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$Repositories$Dockerimages$List; + {}) as Params$Resource$Projects$Locations$Repositories$Attachments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Dockerimages$List; + {} as Params$Resource$Projects$Locations$Repositories$Attachments$Delete; options = {}; } @@ -3558,117 +3687,80 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dockerImages').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); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Dockerimages$Get - extends StandardParameters { - /** - * Required. The name of the docker images. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Dockerimages$List - extends StandardParameters { - /** - * The field to order the results by. - */ - orderBy?: string; - /** - * The maximum number of artifacts to return. Maximum page size is 1,000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request, if any. - */ - pageToken?: string; - /** - * Required. The name of the parent resource whose docker images will be listed. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Repositories$Files { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been deleted. + * Gets an attachment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Files$Delete, + get( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Repositories$Files$Delete, + get( + params?: Params$Resource$Projects$Locations$Repositories$Attachments$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Repositories$Files$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Files$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Files$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Attachments$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Files$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Attachments$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$Repositories$Files$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Attachments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Files$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Attachments$Get; options = {}; } @@ -3683,7 +3775,7 @@ export namespace artifactregistry_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -3694,73 +3786,73 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Download a file. + * Lists attachments. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - download( - params: Params$Resource$Projects$Locations$Repositories$Files$Download, + list( + params: Params$Resource$Projects$Locations$Repositories$Attachments$List, options: StreamMethodOptions ): GaxiosPromise; - download( - params?: Params$Resource$Projects$Locations$Repositories$Files$Download, + list( + params?: Params$Resource$Projects$Locations$Repositories$Attachments$List, options?: MethodOptions - ): GaxiosPromise; - download( - params: Params$Resource$Projects$Locations$Repositories$Files$Download, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Attachments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - download( - params: Params$Resource$Projects$Locations$Repositories$Files$Download, + list( + params: Params$Resource$Projects$Locations$Repositories$Attachments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - download( - params: Params$Resource$Projects$Locations$Repositories$Files$Download, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Attachments$List, + callback: BodyResponseCallback ): void; - download(callback: BodyResponseCallback): void; - download( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Files$Download - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Attachments$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$Repositories$Files$Download; + {}) as Params$Resource$Projects$Locations$Repositories$Attachments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Files$Download; + {} as Params$Resource$Projects$Locations$Repositories$Attachments$List; options = {}; } @@ -3774,7 +3866,7 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:download').replace( + url: (rootUrl + '/v1/{+parent}/attachments').replace( /([^:]\/)\/+/g, '$1' ), @@ -3784,22 +3876,79 @@ export namespace artifactregistry_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Repositories$Attachments$Create + extends StandardParameters { /** - * Gets a file. + * Required. The attachment id to use for this attachment. + */ + attachmentId?: string; + /** + * Required. The name of the parent resource where the attachment will be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Attachment; + } + export interface Params$Resource$Projects$Locations$Repositories$Attachments$Delete + extends StandardParameters { + /** + * Required. The name of the attachment to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Attachments$Get + extends StandardParameters { + /** + * Required. The name of the attachment to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Attachments$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `target` * `type` * `attachment_namespace` + */ + filter?: string; + /** + * The maximum number of attachments to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * Required. The name of the parent resource whose attachments will be listed. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Repositories$Dockerimages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a docker image. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3807,57 +3956,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Repositories$Files$Get, + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Repositories$Files$Get, + params?: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Repositories$Files$Get, + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Files$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Files$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Files$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Dockerimages$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$Repositories$Files$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Dockerimages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Files$Get; + {} as Params$Resource$Projects$Locations$Repositories$Dockerimages$Get; options = {}; } @@ -3883,19 +4025,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists files. + * Lists docker images. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3903,53 +4043,55 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Repositories$Files$List, + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Repositories$Files$List, + params?: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Repositories$Files$List, + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Files$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Files$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Dockerimages$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Files$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Dockerimages$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$Repositories$Files$List; + {}) as Params$Resource$Projects$Locations$Repositories$Dockerimages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Files$List; + {} as Params$Resource$Projects$Locations$Repositories$Dockerimages$List; options = {}; } @@ -3963,7 +4105,7 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/files').replace( + url: (rootUrl + '/v1/{+parent}/dockerImages').replace( /([^:]\/)\/+/g, '$1' ), @@ -3978,49 +4120,31 @@ export namespace artifactregistry_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$Repositories$Files$Delete - extends StandardParameters { - /** - * Required. The name of the file to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Files$Download - extends StandardParameters { - /** - * Required. The name of the file to download. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Files$Get + export interface Params$Resource$Projects$Locations$Repositories$Dockerimages$Get extends StandardParameters { /** - * Required. The name of the file to retrieve. + * Required. The name of the docker images. */ name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Files$List + export interface Params$Resource$Projects$Locations$Repositories$Dockerimages$List extends StandardParameters { - /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name "my_file.txt" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-file`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" - */ - filter?: string; /** * The field to order the results by. */ orderBy?: string; /** - * The maximum number of files to return. Maximum page size is 1,000. + * The maximum number of artifacts to return. Maximum page size is 1,000. */ pageSize?: number; /** @@ -4028,53 +4152,716 @@ export namespace artifactregistry_v1 { */ pageToken?: string; /** - * Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 + * Required. The name of the parent resource whose docker images will be listed. */ parent?: string; } - export class Resource$Projects$Locations$Repositories$Genericartifacts { + export class Resource$Projects$Locations$Repositories$Files { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Directly uploads a Generic artifact. The returned operation will complete once the resources are uploaded. Package, version, and file resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an `ALREADY_EXISTS` error. + * Deletes a file and all of its content. It is only allowed on generic repositories. The returned operation will complete once the file has been 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. */ - upload( - params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + delete( + params: Params$Resource$Projects$Locations$Repositories$Files$Delete, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Files$Delete, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Repositories$Files$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Files$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Files$Delete, + callback: BodyResponseCallback ): void; - upload( + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.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); + } + } + + /** + * Download a 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. + */ + download( + params: Params$Resource$Projects$Locations$Repositories$Files$Download, + options: StreamMethodOptions + ): GaxiosPromise; + download( + params?: Params$Resource$Projects$Locations$Repositories$Files$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Projects$Locations$Repositories$Files$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Projects$Locations$Repositories$Files$Download, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Projects$Locations$Repositories$Files$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:download').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a 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. + */ + get( + params: Params$Resource$Projects$Locations$Repositories$Files$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Repositories$Files$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Files$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Files$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Files$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.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 files. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Repositories$Files$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Repositories$Files$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Files$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Files$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Files$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/files').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 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. + */ + patch( + params: Params$Resource$Projects$Locations$Repositories$Files$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Repositories$Files$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Repositories$Files$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Files$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Repositories$Files$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.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 + ); + } + } + + /** + * Directly uploads a file to a repository. The returned Operation will complete once the resources are uploaded. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Files$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Repositories$Files$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Repositories$Files$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Files$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Files$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Files$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Files$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Files$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/files:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/v1/{+parent}/files:upload').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Files$Delete + extends StandardParameters { + /** + * Required. The name of the file to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Files$Download + extends StandardParameters { + /** + * Required. The name of the file to download. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Files$Get + extends StandardParameters { + /** + * Required. The name of the file to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Files$List + extends StandardParameters { + /** + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `"annotations.external_link:external_link_value"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-file`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" `` + */ + filter?: string; + /** + * The field to order the results by. + */ + orderBy?: string; + /** + * The maximum number of files to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * Required. The name of the repository whose files will be listed. For example: "projects/p1/locations/us-central1/repositories/repo1 + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Files$Patch + extends StandardParameters { + /** + * The name of the file, for example: `projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt`. If the file ID part contains slashes, they are escaped. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleDevtoolsArtifactregistryV1File; + } + export interface Params$Resource$Projects$Locations$Repositories$Files$Upload + extends StandardParameters { + /** + * Required. The resource name of the repository where the file will be uploaded. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UploadFileRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Projects$Locations$Repositories$Genericartifacts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Directly uploads a Generic artifact. The returned operation will complete once the resources are uploaded. Package, version, and file resources are created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will raise an `ALREADY_EXISTS` 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. + */ + upload( + params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( paramsOrCallback?: | Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload | BodyResponseCallback @@ -4082,23 +4869,535 @@ export namespace artifactregistry_v1 { optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/genericArtifacts:create').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v1/{+parent}/genericArtifacts:create' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload + extends StandardParameters { + /** + * The resource name of the repository where the generic artifact will be uploaded. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UploadGenericArtifactRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Projects$Locations$Repositories$Gomodules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Directly uploads a Go module. The returned Operation will complete once the Go module is uploaded. Package, Version, and File resources are created based on the uploaded Go module. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Gomodules$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Gomodules$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Gomodules$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Gomodules$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/goModules:create').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/v1/{+parent}/goModules:create').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Gomodules$Upload + extends StandardParameters { + /** + * The resource name of the repository where the Go module will be uploaded. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UploadGoModuleRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Projects$Locations$Repositories$Googetartifacts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports GooGet artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Googetartifacts$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + callback: BodyResponseCallback + ): void; + import(callback: BodyResponseCallback): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/googetArtifacts: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); + } + } + + /** + * Directly uploads a GooGet artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Googetartifacts$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/googetArtifacts:create').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v1/{+parent}/googetArtifacts:create' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import + extends StandardParameters { + /** + * The name of the parent resource where the artifacts will be imported. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ImportGoogetArtifactsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload + extends StandardParameters { + /** + * The name of the parent resource where the artifacts will be uploaded. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UploadGoogetArtifactRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Projects$Locations$Repositories$Kfpartifacts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Directly uploads a KFP artifact. The returned Operation will complete once the resource is uploaded. Package, Version, and File resources will be created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will be overwritten. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Kfpartifacts$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + callback: BodyResponseCallback + ): void; + upload( + callback: BodyResponseCallback + ): void; + upload( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload; + {}) as Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Genericartifacts$Upload; + {} as Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload; options = {}; } @@ -4112,7 +5411,7 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/genericArtifacts:create').replace( + url: (rootUrl + '/v1/{+parent}/kfpArtifacts:create').replace( /([^:]\/)\/+/g, '$1' ), @@ -4123,36 +5422,36 @@ export namespace artifactregistry_v1 { ), params, mediaUrl: ( - rootUrl + '/upload/v1/{+parent}/genericArtifacts:create' + rootUrl + '/upload/v1/{+parent}/kfpArtifacts:create' ).replace(/([^:]\/)\/+/g, '$1'), 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$Repositories$Genericartifacts$Upload + export interface Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload extends StandardParameters { /** - * The resource name of the repository where the generic artifact will be uploaded. + * The resource name of the repository where the KFP artifact will be uploaded. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$UploadGenericArtifactRequest; + requestBody?: Schema$UploadKfpArtifactRequest; /** * Media metadata @@ -4170,72 +5469,159 @@ export namespace artifactregistry_v1 { }; } - export class Resource$Projects$Locations$Repositories$Gomodules { + export class Resource$Projects$Locations$Repositories$Mavenartifacts { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Directly uploads a Go module. The returned Operation will complete once the Go module is uploaded. Package, Version, and File resources are created based on the uploaded Go module. + * Gets a maven 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. */ - upload( - params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + get( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + get( + params?: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, + get( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.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 maven 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. + */ + list( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Gomodules$Upload, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - upload( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Gomodules$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Mavenartifacts$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$Repositories$Gomodules$Upload; + {}) as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Gomodules$Upload; + {} as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List; options = {}; } @@ -4249,122 +5635,113 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/goModules:create').replace( + url: (rootUrl + '/v1/{+parent}/mavenArtifacts').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - mediaUrl: (rootUrl + '/upload/v1/{+parent}/goModules:create').replace( - /([^:]\/)\/+/g, - '$1' - ), 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$Repositories$Gomodules$Upload + export interface Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get extends StandardParameters { /** - * The resource name of the repository where the Go module will be uploaded. + * Required. The name of the maven artifact. */ - parent?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List + extends StandardParameters { /** - * Request body metadata + * The maximum number of artifacts to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. */ - requestBody?: Schema$UploadGoModuleRequest; - + pageToken?: string; /** - * Media metadata + * Required. The name of the parent resource whose maven artifacts will be listed. */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; + parent?: string; } - export class Resource$Projects$Locations$Repositories$Googetartifacts { + export class Resource$Projects$Locations$Repositories$Npmpackages { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports GooGet artifacts. The returned Operation will complete once the resources are imported. Package, Version, and File resources are created based on the imported artifacts. Imported artifacts that conflict with existing resources are ignored. + * Gets a npm package. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Googetartifacts$Import, + get( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + get( + params?: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, + callback: BodyResponseCallback ): void; - import(callback: BodyResponseCallback): void; - import( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Npmpackages$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$Repositories$Googetartifacts$Import; + {}) as Params$Resource$Projects$Locations$Repositories$Npmpackages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Import; + {} as Params$Resource$Projects$Locations$Repositories$Npmpackages$Get; options = {}; } @@ -4378,90 +5755,85 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/googetArtifacts:import').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); } } /** - * Directly uploads a GooGet artifact. The returned Operation will complete once the resources are uploaded. Package, Version, and File resources are created based on the imported artifact. Imported artifacts that conflict with existing resources are ignored. + * Lists npm packages. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - upload( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + list( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + list( + params?: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, + list( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, + callback: BodyResponseCallback ): void; - upload( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Npmpackages$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$Repositories$Googetartifacts$Upload; + {}) as Params$Resource$Projects$Locations$Repositories$Npmpackages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload; + {} as Params$Resource$Projects$Locations$Repositories$Npmpackages$List; options = {}; } @@ -4475,142 +5847,122 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/googetArtifacts:create').replace( + url: (rootUrl + '/v1/{+parent}/npmPackages').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - mediaUrl: ( - rootUrl + '/upload/v1/{+parent}/googetArtifacts:create' - ).replace(/([^:]\/)\/+/g, '$1'), 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$Repositories$Googetartifacts$Import + export interface Params$Resource$Projects$Locations$Repositories$Npmpackages$Get extends StandardParameters { /** - * The name of the parent resource where the artifacts will be imported. - */ - parent?: string; - - /** - * Request body metadata + * Required. The name of the npm package. */ - requestBody?: Schema$ImportGoogetArtifactsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Googetartifacts$Upload + export interface Params$Resource$Projects$Locations$Repositories$Npmpackages$List extends StandardParameters { /** - * The name of the parent resource where the artifacts will be uploaded. + * The maximum number of artifacts to return. Maximum page size is 1,000. */ - parent?: string; - + pageSize?: number; /** - * Request body metadata + * The next_page_token value returned from a previous list request, if any. */ - requestBody?: Schema$UploadGoogetArtifactRequest; - + pageToken?: string; /** - * Media metadata + * Required. The name of the parent resource whose npm packages will be listed. */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; + parent?: string; } - export class Resource$Projects$Locations$Repositories$Kfpartifacts { + export class Resource$Projects$Locations$Repositories$Packages { context: APIRequestContext; + tags: Resource$Projects$Locations$Repositories$Packages$Tags; + versions: Resource$Projects$Locations$Repositories$Packages$Versions; constructor(context: APIRequestContext) { this.context = context; + this.tags = new Resource$Projects$Locations$Repositories$Packages$Tags( + this.context + ); + this.versions = + new Resource$Projects$Locations$Repositories$Packages$Versions( + this.context + ); } /** - * Directly uploads a KFP artifact. The returned Operation will complete once the resource is uploaded. Package, Version, and File resources will be created based on the uploaded artifact. Uploaded artifacts that conflict with existing resources will be overwritten. + * Deletes a package and all of its versions and tags. The returned operation will complete once the package has been 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. */ - upload( - params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + delete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, options: StreamMethodOptions ): GaxiosPromise; - upload( - params?: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Delete, options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - upload( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, + callback: BodyResponseCallback ): void; - upload( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$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$Repositories$Kfpartifacts$Upload; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Kfpartifacts$Upload; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Delete; options = {}; } @@ -4621,75 +5973,32 @@ export namespace artifactregistry_v1 { const rootUrl = options.rootUrl || 'https://artifactregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/kfpArtifacts:create').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - mediaUrl: ( - rootUrl + '/upload/v1/{+parent}/kfpArtifacts:create' - ).replace(/([^:]\/)\/+/g, '$1'), - 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$Repositories$Kfpartifacts$Upload - extends StandardParameters { - /** - * The resource name of the repository where the KFP artifact will be uploaded. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UploadKfpArtifactRequest; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Projects$Locations$Repositories$Mavenartifacts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a maven artifact. + * Gets a package. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4697,50 +6006,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, + params: Params$Resource$Projects$Locations$Repositories$Packages$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, + params: Params$Resource$Projects$Locations$Repositories$Packages$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$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$Repositories$Mavenartifacts$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$Get; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Get; options = {}; } @@ -4766,17 +6075,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists maven artifacts. + * Lists packages. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4784,57 +6093,55 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + params: Params$Resource$Projects$Locations$Repositories$Packages$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + params?: Params$Resource$Projects$Locations$Repositories$Packages$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + params: Params$Resource$Projects$Locations$Repositories$Packages$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, + params: Params$Resource$Projects$Locations$Repositories$Packages$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$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$Repositories$Mavenartifacts$List; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List; + {} as Params$Resource$Projects$Locations$Repositories$Packages$List; options = {}; } @@ -4848,7 +6155,7 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/mavenArtifacts').replace( + url: (rootUrl + '/v1/{+parent}/packages').replace( /([^:]\/)\/+/g, '$1' ), @@ -4863,98 +6170,68 @@ export namespace artifactregistry_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$Repositories$Mavenartifacts$Get - extends StandardParameters { - /** - * Required. The name of the maven artifact. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Mavenartifacts$List - extends StandardParameters { - /** - * The maximum number of artifacts to return. Maximum page size is 1,000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request, if any. - */ - pageToken?: string; - /** - * Required. The name of the parent resource whose maven artifacts will be listed. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Repositories$Npmpackages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a npm package. + * Updates a package. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Npmpackages$Get, + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Npmpackages$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$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$Repositories$Npmpackages$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Npmpackages$Get; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Patch; options = {}; } @@ -4969,7 +6246,7 @@ export namespace artifactregistry_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -4980,73 +6257,129 @@ export namespace artifactregistry_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$Repositories$Packages$Delete + extends StandardParameters { + /** + * Required. The name of the package to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Get + extends StandardParameters { + /** + * Required. The name of the package to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name `my-package` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/xpackage"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/xpack*"` To filter the results of your request to packages with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request": * `"annotations.external_link:external_link_value"` To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-package`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" `` + */ + filter?: string; + /** + * Optional. The field to order the results by. + */ + orderBy?: string; + /** + * The maximum number of packages to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * Required. The name of the parent resource whose packages will be listed. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Patch + extends StandardParameters { + /** + * The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Package; + } + + export class Resource$Projects$Locations$Repositories$Packages$Tags { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists npm packages. + * Creates a tag. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Npmpackages$List, + create( + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, + create( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Npmpackages$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Npmpackages$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Tags$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$Repositories$Npmpackages$List; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Npmpackages$List; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create; options = {}; } @@ -5060,11 +6393,8 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/npmPackages').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/tags').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -5075,56 +6405,17 @@ export namespace artifactregistry_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$Repositories$Npmpackages$Get - extends StandardParameters { - /** - * Required. The name of the npm package. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Npmpackages$List - extends StandardParameters { - /** - * The maximum number of artifacts to return. Maximum page size is 1,000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request, if any. - */ - pageToken?: string; - /** - * Required. The name of the parent resource whose npm packages will be listed. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Repositories$Packages { - context: APIRequestContext; - tags: Resource$Projects$Locations$Repositories$Packages$Tags; - versions: Resource$Projects$Locations$Repositories$Packages$Versions; - constructor(context: APIRequestContext) { - this.context = context; - this.tags = new Resource$Projects$Locations$Repositories$Packages$Tags( - this.context - ); - this.versions = - new Resource$Projects$Locations$Repositories$Packages$Versions( - this.context - ); - } /** - * Deletes a package and all of its versions and tags. The returned operation will complete once the package has been deleted. + * Deletes a tag. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5132,50 +6423,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Delete, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Tags$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$Repositories$Packages$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete; options = {}; } @@ -5201,17 +6492,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a package. + * Gets a tag. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5219,50 +6510,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Get, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Get, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Get, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Tags$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$Repositories$Packages$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Get; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get; options = {}; } @@ -5288,17 +6579,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists packages. + * Lists tags. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5306,55 +6597,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Repositories$Packages$List, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Repositories$Packages$List, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Repositories$Packages$List, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Packages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Repositories$Packages$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Tags$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$Repositories$Packages$List; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$List; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$List; options = {}; } @@ -5365,13 +6651,10 @@ export namespace artifactregistry_v1 { const rootUrl = options.rootUrl || 'https://artifactregistry.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/packages').replace( - /([^:]\/)\/+/g, - '$1' - ), + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/tags').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -5383,17 +6666,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a package. + * Updates a tag. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5401,50 +6684,50 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Tags$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$Repositories$Packages$Patch; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Patch; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch; options = {}; } @@ -5470,42 +6753,54 @@ export namespace artifactregistry_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$Repositories$Packages$Delete + export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create extends StandardParameters { /** - * Required. The name of the package to delete. + * The name of the parent resource where the tag will be created. */ - name?: string; + parent?: string; + /** + * The tag id to use for this repository. + */ + tagId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Tag; } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Get + export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete extends StandardParameters { /** - * Required. The name of the package to retrieve. + * The name of the tag to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Packages$List + export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to packages with the name "my-package" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/xpackage"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/xpack*"` To filter the results of your request to packages with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request": * "annotations.external_link:external_link_value" To filter the results just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to packages with the annotation key-value pair [`external.link`:`https://example.com/my-package`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-package`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" + * The name of the tag to retrieve. */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$List + extends StandardParameters { /** - * Optional. The field to order the results by. + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project "`y-project` in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` */ - orderBy?: string; + filter?: string; /** - * The maximum number of packages to return. Maximum page size is 1,000. + * The maximum number of tags to return. Maximum page size is 1,000. */ pageSize?: number; /** @@ -5513,14 +6808,14 @@ export namespace artifactregistry_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource whose packages will be listed. + * The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Patch + export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch extends StandardParameters { /** - * The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped. + * The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else must be URL encoded. */ name?: string; /** @@ -5531,68 +6826,68 @@ export namespace artifactregistry_v1 { /** * Request body metadata */ - requestBody?: Schema$Package; + requestBody?: Schema$Tag; } - export class Resource$Projects$Locations$Repositories$Packages$Tags { + export class Resource$Projects$Locations$Repositories$Packages$Versions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a tag. + * Deletes multiple versions across a repository. The returned operation will complete once the versions have been 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. */ - create( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, + batchDelete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, + batchDelete( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create, - callback: BodyResponseCallback + batchDelete( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + batchDelete(callback: BodyResponseCallback): void; + batchDelete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Create; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete; options = {}; } @@ -5606,7 +6901,10 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tags').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/versions:batchDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -5618,17 +6916,17 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a tag. + * Deletes a version and all of its content. The returned operation will complete once the version has been deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5636,50 +6934,137 @@ export namespace artifactregistry_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, + params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://artifactregistry.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 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$Repositories$Packages$Versions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Repositories$Packages$Versions$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$Repositories$Packages$Tags$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get; options = {}; } @@ -5694,7 +7079,7 @@ export namespace artifactregistry_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -5705,68 +7090,73 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a tag. + * Lists versions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Packages$Tags$Get, + list( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, + list( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Versions$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$Repositories$Packages$Tags$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Versions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$List; options = {}; } @@ -5780,80 +7170,83 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/versions').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 tags. + * Updates a version. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Tags$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Packages$Versions$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$Repositories$Packages$Tags$List; + {}) as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$List; + {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch; options = {}; } @@ -5867,80 +7260,165 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tags').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(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete + extends StandardParameters { /** - * Updates a tag. + * The name of the repository holding all requested versions. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchDeleteVersionsRequest; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete + extends StandardParameters { + /** + * By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted. + */ + force?: boolean; + /** + * The name of the version to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get + extends StandardParameters { + /** + * The name of the version to retrieve. + */ + name?: string; + /** + * The view that should be returned in the response. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name `my-version` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/xversion"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/xversion*"` To filter the results of your request to versions with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `"annotations.external_link:external_link_value"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-version`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" `` + */ + filter?: string; + /** + * Optional. The field to order the results by. + */ + orderBy?: string; + /** + * The maximum number of versions to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * The name of the parent resource whose versions will be listed. + */ + parent?: string; + /** + * The view that should be returned in the response. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Patch + extends StandardParameters { + /** + * The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped. + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Version; + } + + export class Resource$Projects$Locations$Repositories$Pythonpackages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a python package. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Packages$Tags$Patch, + get( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, + get( + params?: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Pythonpackages$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$Repositories$Packages$Tags$Patch; + {}) as Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch; + {} as Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get; options = {}; } @@ -5955,7 +7433,7 @@ export namespace artifactregistry_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -5966,141 +7444,75 @@ export namespace artifactregistry_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$Repositories$Packages$Tags$Create - extends StandardParameters { - /** - * The name of the parent resource where the tag will be created. - */ - parent?: string; - /** - * The tag id to use for this repository. - */ - tagId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Tag; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Delete - extends StandardParameters { - /** - * The name of the tag to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Get - extends StandardParameters { - /** - * The name of the tag to retrieve. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$List - extends StandardParameters { - /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` - */ - filter?: string; - /** - * The maximum number of tags to return. Maximum page size is 1,000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request, if any. - */ - pageToken?: string; - /** - * The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$Patch - extends StandardParameters { - /** - * The name of the tag, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/tag1". If the package part contains slashes, the slashes are escaped. The tag part can only have characters in [a-zA-Z0-9\-._~:@], anything else must be URL encoded. - */ - name?: string; - /** - * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Tag; - } - - export class Resource$Projects$Locations$Repositories$Packages$Versions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes multiple versions across a repository. The returned operation will complete once the versions have been deleted. + * Lists python packages. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, + list( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, options: StreamMethodOptions ): GaxiosPromise; - batchDelete( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, + list( + params?: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, options?: MethodOptions - ): GaxiosPromise; - batchDelete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, + callback: BodyResponseCallback ): void; - batchDelete(callback: BodyResponseCallback): void; - batchDelete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Pythonpackages$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$Repositories$Packages$Versions$Batchdelete; + {}) as Params$Resource$Projects$Locations$Repositories$Pythonpackages$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete; + {} as Params$Resource$Projects$Locations$Repositories$Pythonpackages$List; options = {}; } @@ -6114,11 +7526,11 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/versions:batchDelete').replace( + url: (rootUrl + '/v1/{+parent}/pythonPackages').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -6129,68 +7541,105 @@ export namespace artifactregistry_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$Repositories$Pythonpackages$Get + extends StandardParameters { /** - * Deletes a version and all of its content. The returned operation will complete once the version has been deleted. + * Required. The name of the python package. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Pythonpackages$List + extends StandardParameters { + /** + * The maximum number of artifacts to return. Maximum page size is 1,000. + */ + pageSize?: number; + /** + * The next_page_token value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * Required. The name of the parent resource whose python packages will be listed. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Repositories$Rules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a rule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Repositories$Packages$Versions$Delete, + create( + params: Params$Resource$Projects$Locations$Repositories$Rules$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, + create( + params?: Params$Resource$Projects$Locations$Repositories$Rules$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Repositories$Rules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Rules$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Repositories$Rules$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Rules$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$Repositories$Packages$Versions$Delete; + {}) as Params$Resource$Projects$Locations$Repositories$Rules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete; + {} as Params$Resource$Projects$Locations$Repositories$Rules$Create; options = {}; } @@ -6204,80 +7653,85 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/rules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a version + * Deletes a rule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Packages$Versions$Get, + delete( + params: Params$Resource$Projects$Locations$Repositories$Rules$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + delete( + params?: Params$Resource$Projects$Locations$Repositories$Rules$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Repositories$Rules$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Rules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Repositories$Rules$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Rules$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$Repositories$Packages$Versions$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Rules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get; + {} as Params$Resource$Projects$Locations$Repositories$Rules$Delete; options = {}; } @@ -6292,7 +7746,7 @@ export namespace artifactregistry_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -6303,73 +7757,75 @@ export namespace artifactregistry_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists versions. + * Gets a rule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Packages$Versions$List, + get( + params: Params$Resource$Projects$Locations$Repositories$Rules$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, + get( + params?: Params$Resource$Projects$Locations$Repositories$Rules$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Repositories$Rules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, + get( + params: Params$Resource$Projects$Locations$Repositories$Rules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Packages$Versions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Repositories$Rules$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Packages$Versions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Rules$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$Repositories$Packages$Versions$List; + {}) as Params$Resource$Projects$Locations$Repositories$Rules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Packages$Versions$List; + {} as Params$Resource$Projects$Locations$Repositories$Rules$Get; options = {}; } @@ -6383,152 +7839,85 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/versions').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 + ); } } - } - - export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Batchdelete - extends StandardParameters { - /** - * The name of the repository holding all requested versions. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BatchDeleteVersionsRequest; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Delete - extends StandardParameters { - /** - * By default, a version that is tagged may not be deleted. If force=true, the version and any tags pointing to the version are deleted. - */ - force?: boolean; - /** - * The name of the version to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$Get - extends StandardParameters { - /** - * The name of the version to retrieve. - */ - name?: string; - /** - * The view that should be returned in the response. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Repositories$Packages$Versions$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `annotations` Examples of using a filter: To filter the results of your request to versions with the name "my-version" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my-version"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/xversion"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/xversion*"` To filter the results of your request to versions with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to versions with the annotation key-value pair [`external.link`:`https://example.com/my-version`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-version`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" - */ - filter?: string; - /** - * Optional. The field to order the results by. - */ - orderBy?: string; - /** - * The maximum number of versions to return. Maximum page size is 1,000. - */ - pageSize?: number; - /** - * The next_page_token value returned from a previous list request, if any. - */ - pageToken?: string; - /** - * The name of the parent resource whose versions will be listed. - */ - parent?: string; - /** - * The view that should be returned in the response. - */ - view?: string; - } - - export class Resource$Projects$Locations$Repositories$Pythonpackages { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a python package. + * Lists rules. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, + list( + params: Params$Resource$Projects$Locations$Repositories$Rules$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, + list( + params?: Params$Resource$Projects$Locations$Repositories$Rules$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Repositories$Rules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Rules$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Repositories$Rules$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Rules$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$Repositories$Pythonpackages$Get; + {}) as Params$Resource$Projects$Locations$Repositories$Rules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get; + {} as Params$Resource$Projects$Locations$Repositories$Rules$List; options = {}; } @@ -6542,87 +7931,90 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/rules').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 python packages. + * Updates a rule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Repositories$Pythonpackages$List, + patch( + params: Params$Resource$Projects$Locations$Repositories$Rules$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, + patch( + params?: Params$Resource$Projects$Locations$Repositories$Rules$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Repositories$Rules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, + patch( + params: Params$Resource$Projects$Locations$Repositories$Rules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Repositories$Pythonpackages$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Repositories$Rules$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Repositories$Pythonpackages$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Repositories$Rules$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$Repositories$Pythonpackages$List; + {}) as Params$Resource$Projects$Locations$Repositories$Rules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Repositories$Pythonpackages$List; + {} as Params$Resource$Projects$Locations$Repositories$Rules$Patch; options = {}; } @@ -6636,42 +8028,64 @@ export namespace artifactregistry_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/pythonPackages').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(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Repositories$Pythonpackages$Get + export interface Params$Resource$Projects$Locations$Repositories$Rules$Create extends StandardParameters { /** - * Required. The name of the python package. + * Required. The name of the parent resource where the rule will be created. + */ + parent?: string; + /** + * The rule id to use for this repository. + */ + ruleId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleDevtoolsArtifactregistryV1Rule; + } + export interface Params$Resource$Projects$Locations$Repositories$Rules$Delete + extends StandardParameters { + /** + * Required. The name of the rule to delete. */ name?: string; } - export interface Params$Resource$Projects$Locations$Repositories$Pythonpackages$List + export interface Params$Resource$Projects$Locations$Repositories$Rules$Get extends StandardParameters { /** - * The maximum number of artifacts to return. Maximum page size is 1,000. + * Required. The name of the rule to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Repositories$Rules$List + extends StandardParameters { + /** + * The maximum number of rules to return. Maximum page size is 1,000. */ pageSize?: number; /** @@ -6679,10 +8093,26 @@ export namespace artifactregistry_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource whose python packages will be listed. + * Required. The name of the parent repository whose rules will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1`. */ parent?: string; } + export interface Params$Resource$Projects$Locations$Repositories$Rules$Patch + extends StandardParameters { + /** + * The name of the rule, for example: "projects/p1/locations/us-central1/repositories/repo1/rules/rule1". + */ + name?: string; + /** + * The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleDevtoolsArtifactregistryV1Rule; + } export class Resource$Projects$Locations$Repositories$Yumartifacts { context: APIRequestContext; diff --git a/src/apis/artifactregistry/v1beta1.ts b/src/apis/artifactregistry/v1beta1.ts index d4980a1ac7..ff9b8f9b4c 100644 --- a/src/apis/artifactregistry/v1beta1.ts +++ b/src/apis/artifactregistry/v1beta1.ts @@ -489,7 +489,7 @@ export namespace artifactregistry_v1beta1 { */ description?: string | null; /** - * The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". If the package or version ID parts contain slashes, the slashes are escaped. + * The name of the version, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1`. If the package or version ID parts contain slashes, the slashes are escaped. */ name?: string | null; /** @@ -1865,7 +1865,7 @@ export namespace artifactregistry_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Files$List extends StandardParameters { /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name "my_file.txt" in project my-project in the us-central region, in repository my-repo, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`:`external_link_value`], append the following filter expression to your request: * "annotations.external_link:external_link_value" To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * "annotations.external_link" If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * "annotations.`external.link`:`https://example.com/my-file`" You can also filter with annotations with a wildcard to match any number of characters before or after the value: * "annotations.*_link:`*example.com*`" + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `owner` * `annotations` Examples of using a filter: To filter the results of your request to files with the name `my_file.txt` in project `my-project` in the `us-central` region, in repository `my-repo`, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-file.txt"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/my-*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile.txt"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/files/xfile*"` To filter the results of your request to files owned by the version `1.0` in package `pkg1`, append the following filter expression to your request: * `owner="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` To filter the results of your request to files with the annotation key-value pair [`external_link`: `external_link_value`], append the following filter expression to your request: * `"annotations.external_link:external_link_value"` To filter just for a specific annotation key `external_link`, append the following filter expression to your request: * `"annotations.external_link"` If the annotation key or value contains special characters, you can escape them by surrounding the value with backticks. For example, to filter the results of your request to files with the annotation key-value pair [`external.link`:`https://example.com/my-file`], append the following filter expression to your request: * `` "annotations.`external.link`:`https://example.com/my-file`" `` You can also filter with annotations with a wildcard to match any number of characters before or after the value: * `` "annotations.*_link:`*example.com*`" `` */ filter?: string; /** @@ -2682,7 +2682,7 @@ export namespace artifactregistry_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$List extends StandardParameters { /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name "my-tag" in package "my-package" in repository "my-repo" in project "my-project" in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `name` * `version` Examples of using a filter: To filter the results of your request to tags with the name `my-tag` in package `my-package` in repository `my-repo` in project "`y-project` in the us-central region, append the following filter expression to your request: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my-tag"` You can also use wildcards to match any number of characters before or after the value: * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/my*"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag"` * `name="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/tags/xtag*"` To filter the results of your request to tags applied to the version `1.0` in package `my-package`, append the following filter expression to your request: * `version="projects/my-project/locations/us-central1/repositories/my-repo/packages/my-package/versions/1.0"` */ filter?: string; /** diff --git a/src/apis/assuredworkloads/v1beta1.ts b/src/apis/assuredworkloads/v1beta1.ts index 2715eef1ed..21c171c7ce 100644 --- a/src/apis/assuredworkloads/v1beta1.ts +++ b/src/apis/assuredworkloads/v1beta1.ts @@ -158,6 +158,41 @@ export namespace assuredworkloads_v1beta1 { */ nextPageToken?: string | null; } + /** + * Operation metadata to give request details of ApplyWorkloadUpdate. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateOperationMetadata { + /** + * 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$GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest { + /** + * The action to be performed on the update. + */ + action?: string | null; + } + /** + * Response for ApplyWorkloadUpdate endpoint. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse { + /** + * The update that was applied. + */ + appliedUpdate?: Schema$GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate; + } /** * Represents move analysis results for an asset. */ @@ -234,6 +269,19 @@ export namespace assuredworkloads_v1beta1 { */ workloads?: Schema$GoogleCloudAssuredworkloadsV1beta1Workload[]; } + /** + * Response of listing the compliance updates per workload with pagination. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse { + /** + * 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$GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate[]; + } /** * 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. */ @@ -273,6 +321,78 @@ export namespace assuredworkloads_v1beta1 { */ detail?: 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$GoogleCloudAssuredworkloadsV1beta1OrgPolicy { + /** + * 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$GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule; + } + /** + * A rule used to express this policy. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRule { + /** + * 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$GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues; + } + /** + * The values allowed for a ListPolicy. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1OrgPolicyPolicyRuleStringValues { + /** + * 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$GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate { + /** + * The org policy currently applied on the assured workload resource. + */ + appliedPolicy?: Schema$GoogleCloudAssuredworkloadsV1beta1OrgPolicy; + /** + * The suggested org policy that replaces the applied policy. + */ + suggestedPolicy?: Schema$GoogleCloudAssuredworkloadsV1beta1OrgPolicy; + } /** * Request for restricting list of available resources in Workload environment. */ @@ -286,6 +406,15 @@ export namespace assuredworkloads_v1beta1 { * Response for restricting the list of allowed resources. */ export interface Schema$GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse {} + /** + * The details of the update. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1UpdateDetails { + /** + * Update to one org policy, e.g. gcp.resourceLocation. + */ + orgPolicyUpdate?: Schema$GoogleCloudAssuredworkloadsV1beta1OrgPolicyUpdate; + } /** * Workload monitoring Violation. */ @@ -456,6 +585,10 @@ export namespace assuredworkloads_v1beta1 { * A Workload object for managing highly regulated workloads of cloud customers. */ export interface Schema$GoogleCloudAssuredworkloadsV1beta1Workload { + /** + * Output only. The number of updates available for the workload. + */ + availableUpdates?: number | null; /** * Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id\}`. For example, `billingAccounts/012345-567890-ABCDEF`. */ @@ -716,6 +849,31 @@ export namespace assuredworkloads_v1beta1 { */ setupStatus?: string | null; } + /** + * A workload update is a change to the workload's compliance configuration. + */ + export interface Schema$GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate { + /** + * The time the update was created. + */ + createTime?: string | null; + /** + * The details of the update. + */ + details?: Schema$GoogleCloudAssuredworkloadsV1beta1UpdateDetails; + /** + * 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; + } /** * The response message for Operations.ListOperations. */ @@ -1027,9 +1185,13 @@ export namespace assuredworkloads_v1beta1 { 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); } @@ -2021,6 +2183,237 @@ export namespace assuredworkloads_v1beta1 { requestBody?: Schema$GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest; } + 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 + '/v1beta1/{+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 + '/v1beta1/{+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$GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest; + } + 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/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts index 0801b73e88..cd68a05287 100644 --- a/src/apis/authorizedbuyersmarketplace/v1.ts +++ b/src/apis/authorizedbuyersmarketplace/v1.ts @@ -1192,19 +1192,19 @@ export namespace authorizedbuyersmarketplace_v1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts index 46488efbba..62e5c89678 100644 --- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -355,7 +355,7 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ export interface Schema$DataSegment { /** - * Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. + * Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. Once set, the currency code cannot be changed. */ cpmFee?: Schema$Money; /** @@ -1238,19 +1238,19 @@ export namespace authorizedbuyersmarketplace_v1alpha { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index 5aeabceab1..a60095fe44 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -411,7 +411,7 @@ export namespace backupdr_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. Identifier. Name of the resource. + * Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource\}/backups/{backup\}"`. `{backup\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource. */ name?: string | null; /** @@ -557,7 +557,7 @@ export namespace backupdr_v1 { serviceLockInfo?: Schema$ServiceLockInfo; } /** - * A `BackupPlan` specifies some common fields, such as `display_name` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. + * A `BackupPlan` specifies some common fields, such as `description` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. */ export interface Schema$BackupPlan { /** @@ -667,6 +667,10 @@ export namespace backupdr_v1 { * Message describing a BackupVault object. */ export interface Schema$BackupVault { + /** + * Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. + */ + accessRestriction?: string | null; /** * Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. */ @@ -704,7 +708,7 @@ export namespace backupdr_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. Identifier. The resource name. + * Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}"`. `{backupvault\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location. */ name?: string | null; /** @@ -799,6 +803,10 @@ export namespace backupdr_v1 { * KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. */ keyRevocationActionType?: string | null; + /** + * Labels to apply to instances that are created from these properties. + */ + labels?: {[key: string]: string} | null; /** * The machine type to use for instances that are created from these properties. */ @@ -1042,7 +1050,7 @@ export namespace backupdr_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. Identifier. The resource name. + * Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}"`. `{datasource\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault. */ name?: string | null; /** @@ -1285,6 +1293,23 @@ export namespace backupdr_v1 { */ backupPlanRuleId?: string | null; } + /** + * Minimum details to identify a Google Cloud resource + */ + export interface Schema$GcpResource { + /** + * Name of the Google Cloud resource. + */ + gcpResourcename?: string | null; + /** + * Location of the resource: //"global"/"unspecified". + */ + location?: string | null; + /** + * Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. + */ + type?: string | null; + } /** * Feature type of the Guest OS. */ @@ -1856,6 +1881,15 @@ export namespace backupdr_v1 { */ requestId?: string | null; } + /** + * Response message for restoring from a Backup. + */ + export interface Schema$RestoreBackupResponse { + /** + * Details of the target resource created/modified as part of restore. + */ + targetResource?: Schema$TargetResource; + } /** * Message for rules config info. */ @@ -1979,6 +2013,10 @@ export namespace backupdr_v1 { */ value?: string | null; } + /** + * Response message from SetStatusInternal method. + */ + export interface Schema$SetInternalStatusResponse {} export interface Schema$SpannerLocation { /** * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata @@ -2052,6 +2090,15 @@ export namespace backupdr_v1 { */ items?: string[] | null; } + /** + * Details of the target resource created/modified as part of restore. + */ + export interface Schema$TargetResource { + /** + * Details of the native Google Cloud resource created as part of restore. + */ + gcpResource?: Schema$GcpResource; + } export interface Schema$TenantProjectProxy { projectNumbers?: string[] | null; } @@ -3328,6 +3375,7 @@ export namespace backupdr_v1 { } /** + * Creates a new BackupVault in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4037,6 +4085,10 @@ export namespace backupdr_v1 { * Required. Name of the backupvault store resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}' */ name?: string; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault + */ + view?: string; } export interface Params$Resource$Projects$Locations$Backupvaults$List extends StandardParameters { @@ -4060,6 +4112,10 @@ export namespace backupdr_v1 { * Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location\}' value. */ parent?: string; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Backupvaults$Patch extends StandardParameters { @@ -4068,7 +4124,7 @@ export namespace backupdr_v1 { */ force?: boolean; /** - * Output only. Identifier. The resource name. + * Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}"`. `{backupvault\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location. */ name?: string; /** @@ -5010,7 +5066,7 @@ export namespace backupdr_v1 { */ allowMissing?: boolean; /** - * Output only. Identifier. The resource name. + * Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\}"`. `{datasource\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault. */ name?: string; /** @@ -5515,6 +5571,10 @@ export namespace backupdr_v1 { * Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{backupVault\}/dataSources/{datasource\}/backups/{backup\}' */ name?: string; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List extends StandardParameters { @@ -5538,11 +5598,15 @@ export namespace backupdr_v1 { * Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. */ parent?: string; + /** + * Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch extends StandardParameters { /** - * Output only. Identifier. Name of the resource. + * Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource\}/backups/{backup\}"`. `{backup\}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource. */ name?: string; /** diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index 903814f947..18ca6aa807 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -448,7 +448,7 @@ export namespace batch_v1 { */ instances?: Schema$InstancePolicyOrTemplate[]; /** - * Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved. + * Custom labels to apply to the job and all the Compute Engine resources that both are created by this allocation policy and support labels. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels). */ labels?: {[key: string]: string} | null; /** @@ -650,7 +650,7 @@ export namespace batch_v1 { */ provisioningModel?: string | null; /** - * Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation. + * Optional. If specified, VMs will consume only the specified reservation. If not specified (default), VMs will consume any applicable reservation. Additionally, VMs will not consume any reservation if "NO_RESERVATION" is specified. */ reservation?: string | null; } @@ -671,7 +671,7 @@ export namespace batch_v1 { */ installOpsAgent?: boolean | null; /** - * Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. + * Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid C++ keyword conflict. Batch only supports global instance templates. You can specify the global instance template as a full or partial URL. */ instanceTemplate?: string | null; /** @@ -713,7 +713,7 @@ export namespace batch_v1 { */ createTime?: string | null; /** - * Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" \} You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved. + * Custom labels to apply to the job and any Cloud Logging [LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) that it generates. Use labels to group and describe the resources they are applied to. Batch automatically applies predefined labels and supports multiple `labels` fields for each job, which each let you apply custom labels to various resources. Label names that start with "goog-" or "google-" are reserved for predefined labels. For more information about labels with Batch, see [Organize resources using labels](https://cloud.google.com/batch/docs/organize-resources-using-labels). */ labels?: {[key: string]: string} | null; /** diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index a5544c4b2c..61e6caa6fa 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1029,6 +1029,194 @@ export namespace beyondcorp_v1 { */ verb?: string | null; } + /** + * A Beyondcorp Application resource information. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Application { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. An arbitrary user-provided name for the Application resource. Cannot exceed 64 characters. + */ + displayName?: string | null; + /** + * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matcher is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one the conditions are met. The conditions can be one of the following combination (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.abc.com"), ("xyz.abc.com") Hostname and Ports - ("abc.com" and "22"), ("abc.com" and "22,33") etc + */ + endpointMatchers?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher[]; + /** + * Identifier. Name of the resource. + */ + name?: string | null; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * EndpointMatcher contains the information of the endpoint that will match the application. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1EndpointMatcher { + /** + * Required. Hostname of the application. + */ + hostname?: string | null; + /** + * Optional. Ports of the application. + */ + ports?: number[] | null; + } + /** + * The Hub message contains information pertaining to the regional data path deployments. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Hub { + /** + * Optional. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits. + */ + natGatewayConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1NatGatewayConfig; + } + /** + * Message for response to listing Applications. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ListApplicationsResponse { + /** + * A list of BeyondCorp Application in the project. + */ + applications?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Application[]; + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * A list of locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing SecurityGateways. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1ListSecurityGatewaysResponse { + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * A list of BeyondCorp SecurityGateway in the project. + */ + securityGateways?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway[]; + /** + * A list of locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Represents the NAT Gateway configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1NatGatewayConfig { + /** + * Output only. List of NAT IPs that will be used for establishing connection to the endpoints. + */ + natIps?: string[] | null; + } + /** + * VPC Peering details. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Peering { + /** + * Optional. List of DNS zones for DNS peering with the customer VPC network. + */ + dnsZones?: string[] | null; + /** + * Required. The name of the Target VPC network name in the format: `projects/{project\}/global/networks/{network\} + */ + targetVpcNetwork?: string | null; + } + /** + * Information about a BeyoncCorp SecurityGateway resource. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. An arbitrary user-provided name for the SecurityGateway. Cannot exceed 64 characters. + */ + displayName?: string | null; + /** + * Output only. IP addresses that will be used for establishing connection to the endpoints. + */ + externalIps?: string[] | null; + /** + * Optional. Map of Hubs that represents regional data path deployment with GCP region as a key. + */ + hubs?: { + [key: string]: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Hub; + } | null; + /** + * Identifier. Name of the resource. + */ + name?: string | null; + /** + * Output only. The operational state of the SecurityGateway. + */ + state?: string | null; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata { + /** + * 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; + } + /** + * Set Peering request for creating a VPC peering between Google network and customer networks. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean | null; + /** + * Required. List of Peering connection information. + */ + vpcPeerings?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Peering[]; + } /** * The response message for Locations.ListLocations. */ @@ -2768,7 +2956,9 @@ export namespace beyondcorp_v1 { appGateways: Resource$Projects$Locations$Appgateways; clientConnectorServices: Resource$Projects$Locations$Clientconnectorservices; clientGateways: Resource$Projects$Locations$Clientgateways; + global: Resource$Projects$Locations$Global; operations: Resource$Projects$Locations$Operations; + securityGateways: Resource$Projects$Locations$Securitygateways; constructor(context: APIRequestContext) { this.context = context; this.appConnections = new Resource$Projects$Locations$Appconnections( @@ -2785,9 +2975,13 @@ export namespace beyondcorp_v1 { this.clientGateways = new Resource$Projects$Locations$Clientgateways( this.context ); + this.global = new Resource$Projects$Locations$Global(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.securityGateways = new Resource$Projects$Locations$Securitygateways( + this.context + ); } /** @@ -6656,64 +6850,94 @@ export namespace beyondcorp_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Global { + context: APIRequestContext; + securityGateways: Resource$Projects$Locations$Global$Securitygateways; + constructor(context: APIRequestContext) { + this.context = context; + this.securityGateways = + new Resource$Projects$Locations$Global$Securitygateways(this.context); + } + } + + export class Resource$Projects$Locations$Global$Securitygateways { + context: APIRequestContext; + applications: Resource$Projects$Locations$Global$Securitygateways$Applications; + constructor(context: APIRequestContext) { + this.context = context; + this.applications = + new Resource$Projects$Locations$Global$Securitygateways$Applications( + this.context + ); + } + } + + export class Resource$Projects$Locations$Global$Securitygateways$Applications { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Creates a new Application in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create; options = {}; } @@ -6726,74 +6950,303 @@ export namespace beyondcorp_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/applications').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Updates the parameters of a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + patch( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$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$Global$Securitygateways$Applications$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$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$Global$Securitygateways$Applications$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch; + 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}').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$Securitygateways$Applications$Create + extends StandardParameters { + /** + * Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + */ + applicationId?: string; + /** + * Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Application; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1Application; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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') { @@ -7067,4 +7520,1022 @@ export namespace beyondcorp_v1 { */ pageToken?: string; } + + export class Resource$Projects$Locations$Securitygateways { + context: APIRequestContext; + applications: Resource$Projects$Locations$Securitygateways$Applications; + constructor(context: APIRequestContext) { + this.context = context; + this.applications = + new Resource$Projects$Locations$Securitygateways$Applications( + this.context + ); + } + + /** + * Creates a new SecurityGateway in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Securitygateways$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Securitygateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Securitygateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Securitygateways$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 SecurityGateways in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Securitygateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Securitygateways$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Securitygateways$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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); + } + } + + /** + * This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + options: StreamMethodOptions + ): GaxiosPromise; + setPeering( + params?: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + options?: MethodOptions + ): GaxiosPromise; + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + callback: BodyResponseCallback + ): void; + setPeering( + callback: BodyResponseCallback + ): void; + setPeering( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Setpeering + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Setpeering; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Setpeering; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+securityGateway}:setPeering').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['securityGateway'], + pathParams: ['securityGateway'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Securitygateways$Create + extends StandardParameters { + /** + * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/{location_id\}` + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + */ + securityGatewayId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Delete + extends StandardParameters { + /** + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/{location_id\}/securityGateways/{security_gateway_id\}` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Get + extends StandardParameters { + /** + * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/{location_id\}/securityGateway/{security_gateway_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$List + extends StandardParameters { + /** + * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/{location_id\}/` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name, hubs. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGateway; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Setpeering + extends StandardParameters { + /** + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project\}/locations/{location\}/securityGateways/{security_gateway\}` + */ + securityGateway?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SetPeeringRequest; + } + + export class Resource$Projects$Locations$Securitygateways$Applications { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Applications$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; + 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}').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 Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Applications$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; + 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}').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 Applications in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Applications$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/applications').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$Securitygateways$Applications$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; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Get + extends StandardParameters { + /** + * Required. The resource name of the Application using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/applications/{application_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$List + extends StandardParameters { + /** + * Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName "test-application" For more information, please refer to https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + */ + parent?: string; + } } diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 4f4ad27080..2abec0256e 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1624,18 +1624,18 @@ export namespace beyondcorp_v1alpha { * A Beyondcorp Application resource information. */ export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication { - /** - * Required. Application filter conditions associated with an application. - */ - applicationMatchFilter?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter; /** * Output only. Timestamp when the resource was created. */ createTime?: string | null; /** - * Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters. + * Optional. An arbitrary user-provided name for the Application resource. Cannot exceed 64 characters. */ displayName?: string | null; + /** + * Required. Endpoint matchers associated with an application. A combination of hostname and ports as endpoint matcher is used to match the application. Match conditions for OR logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if one the conditions are met. The conditions can be one of the following combination (Hostname), (Hostname & Ports) EXAMPLES: Hostname - ("*.abc.com"), ("xyz.abc.com") Hostname and Ports - ("abc.com" and "22"), ("abc.com" and "22,33") etc + */ + endpointMatchers?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher[]; /** * Identifier. Name of the resource. */ @@ -1646,72 +1646,26 @@ export namespace beyondcorp_v1alpha { updateTime?: string | null; } /** - * Match Criteria for Application Filtering. - */ - export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter { - /** - * Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5") - */ - matchConditions?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition[]; - } - /** - * Match condition for idenfying the application. + * EndpointMatcher contains the information of the endpoint that will match the application. */ - export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition { - /** - * Optional. FQDN of the application. - */ - fqdn?: string | null; + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaEndpointMatcher { /** - * Optional. IP Address of the application. + * Required. Hostname of the application. */ - ipAddress?: string | null; + hostname?: string | null; /** * Optional. Ports of the application. */ ports?: number[] | null; } /** - * A Beyondcorp Hub resource information. + * The Hub message contains information pertaining to the regional data path deployments. */ export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub { /** - * Output only. Timestamp when the resource was created. - */ - createTime?: string | null; - /** - * Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters. - */ - displayName?: string | null; - /** - * Identifier. Name of the resource. - */ - name?: string | null; - /** - * Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits. - */ - natGatewayConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig; - /** - * Output only. The operational state of the Hub. - */ - state?: string | null; - /** - * Output only. Timestamp when the resource was last modified. - */ - updateTime?: string | null; - } - /** - * Represents the NAT Gateway configuration. - */ - export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig { - /** - * Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected. - */ - enableNatGateway?: boolean | null; - /** - * Output only. List of NAT IPs that will be used for establishing connection to the endpoints. + * Optional. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits. */ - natIps?: string[] | null; + natGatewayConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaNatGatewayConfig; } /** * Message for response to listing Applications. @@ -1731,38 +1685,43 @@ export namespace beyondcorp_v1alpha { unreachable?: string[] | null; } /** - * Message for response to listing Hubs. + * Message for response to listing SecurityGateways. */ - export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse { - /** - * A list of BeyondCorp Hub in the project. - */ - hubs?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub[]; + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse { /** * A token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string | null; + /** + * A list of BeyondCorp SecurityGateway in the project. + */ + securityGateways?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway[]; /** * A list of locations that could not be reached. */ unreachable?: string[] | null; } /** - * Message for response to listing SecurityGateways. + * Represents the NAT Gateway configuration. */ - export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse { + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaNatGatewayConfig { /** - * A token to retrieve the next page of results, or empty if there are no more results in the list. + * Output only. List of NAT IPs that will be used for establishing connection to the endpoints. */ - nextPageToken?: string | null; + natIps?: string[] | null; + } + /** + * VPC Peering details. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaPeering { /** - * A list of BeyondCorp SecurityGateway in the project. + * Optional. List of DNS zones for DNS peering with the customer VPC network. */ - securityGateways?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway[]; + dnsZones?: string[] | null; /** - * A list of locations that could not be reached. + * Required. The name of the Target VPC network name in the format: `projects/{project\}/global/networks/{network\} */ - unreachable?: string[] | null; + targetVpcNetwork?: string | null; } /** * Information about a BeyoncCorp SecurityGateway resource. @@ -1780,6 +1739,12 @@ export namespace beyondcorp_v1alpha { * Output only. IP addresses that will be used for establishing connection to the endpoints. */ externalIps?: string[] | null; + /** + * Optional. Map of Hubs that represents regional data path deployment with GCP region as a key. + */ + hubs?: { + [key: string]: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub; + } | null; /** * Identifier. Name of the resource. */ @@ -1826,6 +1791,56 @@ export namespace beyondcorp_v1alpha { */ verb?: string | null; } + /** + * Set Peering request for creating a VPC peering between Google network and customer networks. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSetPeeringRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, 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; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean | null; + /** + * Required. List of Peering connection information. + */ + vpcPeerings?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaPeering[]; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1SecurityGatewayOperationMetadata { + /** + * 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 Locations.ListLocations. */ @@ -6424,7 +6439,6 @@ export namespace beyondcorp_v1alpha { connectors: Resource$Projects$Locations$Connectors; global: Resource$Projects$Locations$Global; insights: Resource$Projects$Locations$Insights; - netConnections: Resource$Projects$Locations$Netconnections; operations: Resource$Projects$Locations$Operations; securityGateways: Resource$Projects$Locations$Securitygateways; constructor(context: APIRequestContext) { @@ -6456,9 +6470,6 @@ export namespace beyondcorp_v1alpha { ); this.global = new Resource$Projects$Locations$Global(this.context); this.insights = new Resource$Projects$Locations$Insights(this.context); - this.netConnections = new Resource$Projects$Locations$Netconnections( - this.context - ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -13091,16 +13102,12 @@ export namespace beyondcorp_v1alpha { export class Resource$Projects$Locations$Global$Securitygateways { context: APIRequestContext; applications: Resource$Projects$Locations$Global$Securitygateways$Applications; - hubs: Resource$Projects$Locations$Global$Securitygateways$Hubs; constructor(context: APIRequestContext) { this.context = context; this.applications = new Resource$Projects$Locations$Global$Securitygateways$Applications( this.context ); - this.hubs = new Resource$Projects$Locations$Global$Securitygateways$Hubs( - this.context - ); } } @@ -13401,7 +13408,7 @@ export namespace beyondcorp_v1alpha { export interface Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create extends StandardParameters { /** - * Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + * Optional. User-settable Application resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. */ applicationId?: string; /** @@ -13451,72 +13458,72 @@ export namespace beyondcorp_v1alpha { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Global$Securitygateways$Hubs { + export class Resource$Projects$Locations$Insights { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new Hub in a given project and location. + * Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + configuredInsight( + params?: Params$Resource$Projects$Locations$Insights$Configuredinsight, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + ): GaxiosPromise; + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, - callback: BodyResponseCallback + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + configuredInsight( + callback: BodyResponseCallback ): void; - create( + configuredInsight( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$Configuredinsight + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create; + {}) as Params$Resource$Projects$Locations$Insights$Configuredinsight; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create; + {} as Params$Resource$Projects$Locations$Insights$Configuredinsight; options = {}; } @@ -13529,90 +13536,91 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/hubs').replace( + url: (rootUrl + '/v1alpha/{+insight}:configuredInsight').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['insight'], + pathParams: ['insight'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates the parameters of a single Hub. + * Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days starting the day before. The insight data size will be limited to 50 rows. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + get( + params: Params$Resource$Projects$Locations$Insights$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + get( + params?: Params$Resource$Projects$Locations$Insights$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Insights$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + get( + params: Params$Resource$Projects$Locations$Insights$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Insights$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$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$Global$Securitygateways$Hubs$Patch; + {}) as Params$Resource$Projects$Locations$Insights$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch; + params = {} as Params$Resource$Projects$Locations$Insights$Get; options = {}; } @@ -13626,7 +13634,7 @@ export namespace beyondcorp_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -13637,75 +13645,76 @@ export namespace beyondcorp_v1alpha { 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 for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Insights$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Insights$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Insights$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Insights$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Insights$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Insights$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Insights$List; options = {}; } @@ -13718,152 +13727,185 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1alpha/{+parent}/insights').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create + export interface Params$Resource$Projects$Locations$Insights$Configuredinsight extends StandardParameters { /** - * Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + * Required. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view. */ - hubId?: string; + aggregation?: string; /** - * Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + * Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). */ - parent?: string; + 'customGrouping.fieldFilter'?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + * Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here. */ - requestId?: string; - + 'customGrouping.groupFields'?: string[]; /** - * Request body metadata + * Required. Ending time for the duration for which insight is to be pulled. + */ + endTime?: string; + /** + * Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). + */ + fieldFilter?: string; + /** + * Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view. + */ + group?: string; + /** + * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}`. + */ + insight?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Used to fetch the page represented by the token. Fetches the first page when not set. + */ + pageToken?: string; + /** + * Required. Starting time for the duration for which insight is to be pulled. */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub; + startTime?: string; } - export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch + export interface Params$Resource$Projects$Locations$Insights$Get extends StandardParameters { /** - * Identifier. Name of the resource. + * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}` */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Required. Metadata only or full data view. */ - requestId?: string; + view?: string; + } + export interface Params$Resource$Projects$Locations$Insights$List + extends StandardParameters { /** - * Required. Mutable fields include: display_name. + * Optional. Aggregation type. The default is 'DAILY'. */ - updateMask?: string; - + aggregation?: string; /** - * Request body metadata + * Optional. Ending time for the duration for which insights are to be pulled. The default is the current time. */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub; - } - export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions - extends StandardParameters { + endTime?: 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. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). */ - resource?: string; - + filter?: string; /** - * Request body metadata + * Optional. Hint for how to order the results. This is currently ignored. */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The resource name of InsightMetadata using the form: `organizations/{organization_id\}/locations/{location\}` `projects/{project_id\}/locations/{location_id\}` + */ + parent?: string; + /** + * Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time. + */ + startTime?: string; + /** + * Required. List only metadata or full data. + */ + view?: string; } - export class Resource$Projects$Locations$Insights { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. + * 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. */ - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - configuredInsight( - params?: Params$Resource$Projects$Locations$Insights$Configuredinsight, + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - configuredInsight( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - configuredInsight( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$Configuredinsight - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$Configuredinsight; + {}) as Params$Resource$Projects$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Insights$Configuredinsight; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; options = {}; } @@ -13876,91 +13918,82 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+insight}:configuredInsight').replace( + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['insight'], - pathParams: ['insight'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days starting the day before. The insight data size will be limited to 50 rows. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight. + * 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. */ - get( - params: Params$Resource$Projects$Locations$Insights$Get, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Insights$Get, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Insights$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Insights$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Insights$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$Get; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Insights$Get; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -13974,7 +14007,7 @@ export namespace beyondcorp_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -13985,735 +14018,33 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas. + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Insights$List, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Insights$List, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Insights$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Insights$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Insights$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Insights$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}/insights').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Insights$Configuredinsight - extends StandardParameters { - /** - * Required. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view. - */ - aggregation?: string; - /** - * Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - 'customGrouping.fieldFilter'?: string; - /** - * Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here. - */ - 'customGrouping.groupFields'?: string[]; - /** - * Required. Ending time for the duration for which insight is to be pulled. - */ - endTime?: string; - /** - * Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - fieldFilter?: string; - /** - * Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view. - */ - group?: string; - /** - * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}`. - */ - insight?: string; - /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. - */ - pageSize?: number; - /** - * Optional. Used to fetch the page represented by the token. Fetches the first page when not set. - */ - pageToken?: string; - /** - * Required. Starting time for the duration for which insight is to be pulled. - */ - startTime?: string; - } - export interface Params$Resource$Projects$Locations$Insights$Get - extends StandardParameters { - /** - * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}` - */ - name?: string; - /** - * Required. Metadata only or full data view. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Insights$List - extends StandardParameters { - /** - * Optional. Aggregation type. The default is 'DAILY'. - */ - aggregation?: string; - /** - * Optional. Ending time for the duration for which insights are to be pulled. The default is the current time. - */ - endTime?: string; - /** - * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. Hint for how to order the results. This is currently ignored. - */ - orderBy?: string; - /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results the server should return. - */ - pageToken?: string; - /** - * Required. The resource name of InsightMetadata using the form: `organizations/{organization_id\}/locations/{location\}` `projects/{project_id\}/locations/{location_id\}` - */ - parent?: string; - /** - * Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time. - */ - startTime?: string; - /** - * Required. List only metadata or full data. - */ - view?: string; - } - - export class Resource$Projects$Locations$Netconnections { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Netconnections$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Netconnections$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Netconnections$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: StreamMethodOptions - ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, - options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback - ): void; - cancel(callback: BodyResponseCallback): void; - cancel( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; @@ -14935,16 +14266,12 @@ export namespace beyondcorp_v1alpha { export class Resource$Projects$Locations$Securitygateways { context: APIRequestContext; applications: Resource$Projects$Locations$Securitygateways$Applications; - hubs: Resource$Projects$Locations$Securitygateways$Hubs; constructor(context: APIRequestContext) { this.context = context; this.applications = new Resource$Projects$Locations$Securitygateways$Applications( this.context ); - this.hubs = new Resource$Projects$Locations$Securitygateways$Hubs( - this.context - ); } /** @@ -15343,235 +14670,46 @@ export namespace beyondcorp_v1alpha { list( params: Params$Resource$Projects$Locations$Securitygateways$List, options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Securitygateways$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Securitygateways$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Securitygateways$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates the parameters of a single SecurityGateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Securitygateways$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Securitygateways$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - 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$Securitygateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + callback: BodyResponseCallback ): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Securitygateways$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Securitygateways$List; options = {}; } @@ -15584,90 +14722,92 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of a single SecurityGateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Securitygateways$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$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$Securitygateways$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Securitygateways$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; + {} as Params$Resource$Projects$Locations$Securitygateways$Patch; options = {}; } @@ -15680,220 +14820,85 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Securitygateways$Create - extends StandardParameters { - /** - * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/{location_id\}` - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. - */ - requestId?: string; - /** - * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. - */ - securityGatewayId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Delete - extends StandardParameters { - /** - * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/{location_id\}/securityGateways/{security_gateway_id\}` - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. - */ - validateOnly?: boolean; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Get - extends StandardParameters { - /** - * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/{location_id\}/securityGateway/{security_gateway_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Securitygateways$List - extends StandardParameters { - /** - * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. - */ - filter?: string; - /** - * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. - */ - orderBy?: string; - /** - * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. - */ - pageSize?: number; - /** - * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. - */ - pageToken?: string; - /** - * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/{location_id\}/` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Patch - extends StandardParameters { - /** - * Identifier. Name of the resource. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Required. Mutable fields include: display_name, gateway_regions. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Securitygateways$Applications { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes a single Application. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - delete( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Applications$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$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$Securitygateways$Applications$Delete; + {}) as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; + {} as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; options = {}; } @@ -15906,87 +14911,90 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of a single Application. + * This is a custom method to allow customers to create a peering connections between Google network and customer networks. This is enabled only for the allowlisted customers. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + setPeering( + params?: Params$Resource$Projects$Locations$Securitygateways$Setpeering, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + ): GaxiosPromise; + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, - callback: BodyResponseCallback + setPeering( + params: Params$Resource$Projects$Locations$Securitygateways$Setpeering, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + setPeering( + callback: BodyResponseCallback ): void; - get( + setPeering( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Applications$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Setpeering + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; + {}) as Params$Resource$Projects$Locations$Securitygateways$Setpeering; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; + {} as Params$Resource$Projects$Locations$Securitygateways$Setpeering; options = {}; } @@ -15999,89 +15007,90 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+securityGateway}:setPeering').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['securityGateway'], + pathParams: ['securityGateway'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists Applications in a given project and location. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Applications$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$List; + {}) as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Applications$List; + {} as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; options = {}; } @@ -16094,37 +15103,57 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/applications').replace( + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Delete + export interface Params$Resource$Projects$Locations$Securitygateways$Create extends StandardParameters { /** - * Required. Name of the resource. + * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/{location_id\}` + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + */ + securityGatewayId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Delete + extends StandardParameters { + /** + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/{location_id\}/securityGateways/{security_gateway_id\}` */ name?: string; /** @@ -16136,17 +15165,28 @@ export namespace beyondcorp_v1alpha { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Get + export interface Params$Resource$Projects$Locations$Securitygateways$Get extends StandardParameters { /** - * Required. The resource name of the Application using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/applications/{application_id\}` + * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/{location_id\}/securityGateway/{security_gateway_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Securitygateways$Applications$List + export interface Params$Resource$Projects$Locations$Securitygateways$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$List extends StandardParameters { /** - * Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-application" For more information, please refer to https://google.aip.dev/160. + * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. */ filter?: string; /** @@ -16158,23 +15198,79 @@ export namespace beyondcorp_v1alpha { */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous ListHubsRequest, if any. + * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/{location_id\}/` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name, hubs. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Setpeering + extends StandardParameters { + /** + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project\}/locations/{location\}/securityGateways/{security_gateway\}` + */ + securityGateway?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSetPeeringRequest; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - pageToken?: string; + resource?: string; + /** - * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Securitygateways$Hubs { + export class Resource$Projects$Locations$Securitygateways$Applications { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes a single Hub. + * Deletes a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16182,27 +15278,27 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, callback: BodyResponseCallback ): void; delete( @@ -16210,7 +15306,7 @@ export namespace beyondcorp_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete + | Params$Resource$Projects$Locations$Securitygateways$Applications$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16226,13 +15322,13 @@ export namespace beyondcorp_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete; + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; options = {}; } @@ -16267,7 +15363,7 @@ export namespace beyondcorp_v1alpha { } /** - * Gets details of a single Hub. + * Gets details of a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16275,57 +15371,57 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Hubs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Applications$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$Get; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$Get; + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; options = {}; } @@ -16350,19 +15446,113 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists Hubs in a given project and location. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Applications in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16370,57 +15560,57 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Hubs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Applications$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$List; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$List; + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$List; options = {}; } @@ -16433,7 +15623,7 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/hubs').replace( + url: (rootUrl + '/v1alpha/{+parent}/applications').replace( /([^:]\/)\/+/g, '$1' ), @@ -16448,19 +15638,113 @@ export namespace beyondcorp_v1alpha { 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } - export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Delete extends StandardParameters { /** * Required. Name of the resource. @@ -16475,17 +15759,28 @@ export namespace beyondcorp_v1alpha { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$Get + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Get extends StandardParameters { /** - * Required. The resource name of the Hub using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/hubs/{hub_id\}` + * Required. The resource name of the Application using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/applications/{application_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$List + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$List extends StandardParameters { /** - * Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-hub" For more information, please refer to https://google.aip.dev/160. + * Optional. A filter specifying constraints of a list operation. All fields in the Application message are supported. For example, the following query will return the Application with displayName "test-application" For more information, please refer to https://google.aip.dev/160. */ filter?: string; /** @@ -16497,7 +15792,7 @@ export namespace beyondcorp_v1alpha { */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous ListHubsRequest, if any. + * Optional. The next_page_token value returned from a previous ListApplicationsRequest, if any. */ pageToken?: string; /** @@ -16505,4 +15800,16 @@ export namespace beyondcorp_v1alpha { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$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; + } } diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 4953eb1f74..d037b4e556 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -976,11 +976,11 @@ export namespace bigquery_v2 { */ maxTimeTravelHours?: string | null; /** - * Optional. The [tags](/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](/iam/docs/tags-access-control#definitions) for more details. + * Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. */ resourceTags?: {[key: string]: string} | null; /** - * Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. + * Optional. Output only. Restriction config for all tables and dataset. If set, restrict certain accesses on the dataset and all its tables based on the config. See [Data egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details. */ restrictions?: Schema$RestrictionConfig; /** @@ -1906,7 +1906,7 @@ export namespace bigquery_v2 { walsAlpha?: Schema$DoubleHparamSearchSpace; } /** - * Training info of a trial in [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models. + * Training info of a trial in [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models. */ export interface Schema$HparamTuningTrial { /** @@ -2084,7 +2084,7 @@ export namespace bigquery_v2 { */ id?: string | null; /** - * Output only. The reason why a Job was created. [Preview](/products/#product-launch-stages) + * Output only. The reason why a Job was created. [Preview](https://cloud.google.com/products/#product-launch-stages) */ jobCreationReason?: Schema$JobCreationReason; /** @@ -2512,7 +2512,7 @@ export namespace bigquery_v2 { writeDisposition?: string | null; } /** - * Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](/products/#product-launch-stages) + * Reason about why a Job was created from a [`jobs.query`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For [`jobs.insert`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. [Preview](https://cloud.google.com/products/#product-launch-stages) */ export interface Schema$JobCreationReason { /** @@ -2807,7 +2807,7 @@ export namespace bigquery_v2 { */ sparkStatistics?: Schema$SparkStatistics; /** - * Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + * Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#query_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#aalter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. */ statementType?: string | null; /** @@ -3128,11 +3128,11 @@ export namespace bigquery_v2 { */ export interface Schema$MlStatistics { /** - * Output only. Trials of a [hyperparameter tuning job](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id. + * Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id. */ hparamTrials?: Schema$HparamTuningTrial[]; /** - * Results for all completed iterations. Empty for [hyperparameter tuning jobs](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). + * Results for all completed iterations. Empty for [hyperparameter tuning jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview). */ iterationResults?: Schema$IterationResult[]; /** @@ -3158,7 +3158,7 @@ export namespace bigquery_v2 { */ creationTime?: string | null; /** - * Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. + * Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. */ defaultTrialId?: string | null; /** @@ -3190,7 +3190,7 @@ export namespace bigquery_v2 { */ hparamSearchSpaces?: Schema$HparamSearchSpaces; /** - * Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. + * Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. */ hparamTrials?: Schema$HparamTuningTrial[]; /** @@ -3218,7 +3218,7 @@ export namespace bigquery_v2 { */ modelType?: string | null; /** - * Output only. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. + * Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. */ optimalTrialIds?: string[] | null; /** @@ -3253,7 +3253,7 @@ export namespace bigquery_v2 { */ export interface Schema$ModelExtractOptions { /** - * The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. + * The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. */ trialId?: string | null; } @@ -3548,7 +3548,7 @@ export namespace bigquery_v2 { */ formatOptions?: Schema$DataFormatOptions; /** - * Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](/products/#product-launch-stages) + * Optional. If not set, jobs are always required. If set, the query request will follow the behavior described JobCreationMode. [Preview](https://cloud.google.com/products/#product-launch-stages) */ jobCreationMode?: string | null; /** @@ -3622,7 +3622,7 @@ export namespace bigquery_v2 { */ jobComplete?: boolean | null; /** - * Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](/products/#product-launch-stages) + * Optional. The reason why a Job was created. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. [Preview](https://cloud.google.com/products/#product-launch-stages) */ jobCreationReason?: Schema$JobCreationReason; /** @@ -3642,7 +3642,7 @@ export namespace bigquery_v2 { */ pageToken?: string | null; /** - * Auto-generated ID for the query. [Preview](/products/#product-launch-stages) + * Auto-generated ID for the query. [Preview](https://cloud.google.com/products/#product-launch-stages) */ queryId?: string | null; /** @@ -4305,7 +4305,7 @@ export namespace bigquery_v2 { */ inputFormat?: string | null; /** - * Optional. The physical location of the table (e.g. 'gs://spark-dataproc-data/pangea-data/case_sensitive/' or 'gs://spark-dataproc-data/pangea-data/x'). The maximum length is 2056 bytes. + * Optional. The physical location of the table (e.g. `gs://spark-dataproc-data/pangea-data/case_sensitive/` or `gs://spark-dataproc-data/pangea-data/x`). The maximum length is 2056 bytes. */ locationUri?: string | null; /** @@ -4515,7 +4515,7 @@ export namespace bigquery_v2 { */ resourceTags?: {[key: string]: string} | null; /** - * Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See [Data egress](/bigquery/docs/analytics-hub-introduction#data_egress) for more details. + * Optional. Output only. Restriction config for table. If set, restrict certain accesses on the table based on the config. See [Data egress](https://cloud.google.com/bigquery/docs/analytics-hub-introduction#data_egress) for more details. */ restrictions?: Schema$RestrictionConfig; /** @@ -4551,7 +4551,7 @@ export namespace bigquery_v2 { */ timePartitioning?: Schema$TimePartitioning; /** - * Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. + * Output only. Describes the table type. The following values are supported: * `TABLE`: A normal BigQuery table. * `VIEW`: A virtual table defined by a SQL query. * `EXTERNAL`: A table that references data stored in an external storage system, such as Google Cloud Storage. * `MATERIALIZED_VIEW`: A precomputed view defined by a SQL query. * `SNAPSHOT`: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on [table snapshots](https://cloud.google.com/bigquery/docs/table-snapshots-intro). The default value is `TABLE`. */ type?: string | null; /** @@ -4772,7 +4772,7 @@ export namespace bigquery_v2 { */ tableReference?: Schema$TableReference; /** - * [Table type](/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). + * [Table type](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#Table.FIELDS.type). */ tableType?: string | null; /** @@ -4946,6 +4946,10 @@ export namespace bigquery_v2 { * Subsample ratio of columns when constructing each tree for boosted tree models. */ colsampleBytree?: number | null; + /** + * The contribution metric. Applies to contribution analysis models. Allowed formats supported are for summable and summable ratio contribution metrics. These include expressions such as "SUM(x)" or "SUM(x)/SUM(y)", where x and y are column names from the base table. + */ + contributionMetric?: string | null; /** * Type of normalization algorithm for boosted tree models using dart booster. */ @@ -4970,6 +4974,10 @@ export namespace bigquery_v2 { * If true, perform decompose time series and save the results. */ decomposeTimeSeries?: boolean | null; + /** + * Optional. Names of the columns to slice on. Applies to contribution analysis models. + */ + dimensionIdColumns?: string[] | null; /** * Distance type for clustering models. */ @@ -5034,6 +5042,10 @@ export namespace bigquery_v2 { * Number of integral steps for the integrated gradients explain method. */ integratedGradientsNumSteps?: string | null; + /** + * Name of the column used to determine the rows corresponding to control and test. Applies to contribution analysis models. + */ + isTestColumn?: string | null; /** * Item column specified for matrix factorization models. */ @@ -5090,6 +5102,10 @@ export namespace bigquery_v2 { * Maximum depth of a tree for boosted tree models. */ maxTreeDepth?: string | null; + /** + * The apriori support minimum. Applies to contribution analysis models. + */ + minAprioriSupport?: number | null; /** * When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms. */ diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index 073ee2ad70..84529e2e61 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -314,6 +314,15 @@ export namespace bigquerydatatransfer_v1 { */ dataSourceIds?: string[] | null; } + /** + * Options customizing EventDriven transfers schedule. + */ + export interface Schema$EventDrivenSchedule { + /** + * Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project\}/subscriptions/{subscription\} + */ + pubsubSubscription?: string | null; + } /** * Returns list of supported data sources and their metadata. */ @@ -404,6 +413,10 @@ export namespace bigquerydatatransfer_v1 { */ name?: string | null; } + /** + * Options customizing manual transfers schedule. + */ + export interface Schema$ManualSchedule {} /** * Options customizing the data transfer schedule. */ @@ -421,6 +434,23 @@ export namespace bigquerydatatransfer_v1 { */ startTime?: string | null; } + /** + * V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. + */ + export interface Schema$ScheduleOptionsV2 { + /** + * Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial. + */ + eventDrivenSchedule?: Schema$EventDrivenSchedule; + /** + * Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true. + */ + manualSchedule?: Schema$ManualSchedule; + /** + * Time based transfer schedule options. This is the default schedule option. + */ + timeBasedSchedule?: Schema$TimeBasedSchedule; + } /** * A request to schedule transfer runs for a time range. */ @@ -482,6 +512,23 @@ export namespace bigquerydatatransfer_v1 { */ message?: string | null; } + /** + * Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message. + */ + export interface Schema$TimeBasedSchedule { + /** + * Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. + */ + endTime?: string | null; + /** + * Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. + */ + schedule?: string | null; + /** + * Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. + */ + startTime?: string | null; + } /** * A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive). */ @@ -531,6 +578,10 @@ export namespace bigquerydatatransfer_v1 { * The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent. */ encryptionConfiguration?: Schema$EncryptionConfiguration; + /** + * Output only. Error code with detailed information about reason of the latest config failure. + */ + error?: Schema$Status; /** * Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id\}/locations/{region\}/transferConfigs/{config_id\}` or `projects/{project_id\}/transferConfigs/{config_id\}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. */ @@ -559,6 +610,10 @@ export namespace bigquerydatatransfer_v1 { * Options customizing the data transfer schedule. */ scheduleOptions?: Schema$ScheduleOptions; + /** + * Options customizing different types of data transfer schedule. This field replaces "schedule" and "schedule_options" fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule. + */ + scheduleOptionsV2?: Schema$ScheduleOptionsV2; /** * Output only. State of the most recently updated transfer run. */ diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index d9810ffa6f..1c57c795c1 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -184,11 +184,11 @@ export namespace bigqueryreservation_v1 { */ export interface Schema$CapacityCommitment { /** - * Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. + * Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after renewal, commitment_end_time is the time the renewed commitment expires. So itwould be at a time after commitment_start_time + committed period, because we don't change commitment_start_time , */ commitmentEndTime?: string | null; /** - * Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. + * Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Note after the commitment is renewed, commitment_start_time won't be changed. It refers to the start time of the original commitment. */ commitmentStartTime?: string | null; /** diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 80de3cc413..d03419b24f 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -253,6 +253,10 @@ export namespace bigtableadmin_v2 { * A backup of a Cloud Bigtable table. */ export interface Schema$Backup { + /** + * Indicates the backup type of the backup. + */ + backupType?: string | null; /** * Output only. The encryption information for the backup. */ @@ -265,6 +269,10 @@ export namespace bigtableadmin_v2 { * Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. */ expireTime?: string | null; + /** + * The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. + */ + hotToStandardTime?: string | null; /** * A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. */ @@ -391,6 +399,10 @@ export namespace bigtableadmin_v2 { * The unique name of the cluster. Values are of the form `projects/{project\}/instances/{instance\}/clusters/a-z*`. */ name?: string | null; + /** + * Immutable. The node scaling factor of this cluster. + */ + nodeScalingFactor?: string | null; /** * The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization. */ @@ -1275,6 +1287,10 @@ export namespace bigtableadmin_v2 { * The set of clusters to route to. The order is ignored; clusters will be tried in order of distance. If left empty, all clusters are eligible. */ clusterIds?: string[] | null; + /** + * Row affinity sticky routing based on the row key of the request. Requests that span multiple rows are routed non-deterministically. + */ + rowAffinity?: Schema$RowAffinity; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -1443,6 +1459,10 @@ export namespace bigtableadmin_v2 { */ tableId?: string | null; } + /** + * If enabled, Bigtable will route the request based on the row key of the request, rather than randomly. Instead, each row key will be assigned to a cluster, and will stick to that cluster. If clusters are added or removed, then this may affect which row keys stick to which clusters. To avoid this, users can use a cluster group to specify which clusters are to be used. In this case, new clusters that are not a part of the cluster group will not be routed to, and routing will be unaffected by the new cluster. Moreover, clusters specified in the cluster group cannot be deleted unless removed from the cluster group. + */ + export interface Schema$RowAffinity {} /** * Request message for `SetIamPolicy` method. */ diff --git a/src/apis/businessprofileperformance/v1.ts b/src/apis/businessprofileperformance/v1.ts index 0c3790626b..f8d7b9696e 100644 --- a/src/apis/businessprofileperformance/v1.ts +++ b/src/apis/businessprofileperformance/v1.ts @@ -255,19 +255,19 @@ export namespace businessprofileperformance_v1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } @@ -556,19 +556,19 @@ export namespace businessprofileperformance_v1 { */ 'dailySubEntityType.dayOfWeek'?: string; /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ 'dailySubEntityType.timeOfDay.hours'?: number; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ 'dailySubEntityType.timeOfDay.minutes'?: number; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ 'dailySubEntityType.timeOfDay.nanos'?: number; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ 'dailySubEntityType.timeOfDay.seconds'?: number; /** diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 7abcc4f2c1..63decfe5b2 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -653,11 +653,12 @@ export namespace calendar_v3 { etag?: string | null; /** * Specific type of the event. This cannot be modified after the event is created. Possible values are: + * - "birthday" - A special all-day event with an annual recurrence. * - "default" - A regular event or not further specified. - * - "outOfOffice" - An out-of-office event. * - "focusTime" - A focus-time event. - * - "workingLocation" - A working location event. * - "fromGmail" - An event from Gmail. This type of event cannot be created. + * - "outOfOffice" - An out-of-office event. + * - "workingLocation" - A working location event. */ eventType?: string | null; /** @@ -882,7 +883,7 @@ export namespace calendar_v3 { * - "needsAction" - The attendee has not responded to the invitation (recommended for new events). * - "declined" - The attendee has declined the invitation. * - "tentative" - The attendee has tentatively accepted the invitation. - * - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" won't see an event on their calendar unless they choose to change their invitation response in the event invitation email. + * - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" or "Only if the sender is known" might have their response reset to needsAction and won't see an event in their calendar unless they change their response in the event invitation email. Furthermore, if more than 200 guests are invited to the event, response status is not propagated to the guests. */ responseStatus?: string | null; /** @@ -3926,7 +3927,7 @@ export namespace calendar_v3 { } /** - * Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; outOfOffice, focusTime, workingLocation and fromGmail events cannot be moved. + * Moves an event to another calendar, i.e. changes an event's organizer. Note that only default events can be moved; birthday, focusTime, fromGmail, outOfOffice and workingLocation events cannot be moved. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 60496e96ae..68969a5ce6 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -146,7 +146,7 @@ export namespace chat_v1 { */ accessState?: string | null; /** - * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. Reading the target audience supports: - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` scope in [Developer Preview](https://developers.google.com/workspace/preview). This field is not populated when using the `chat.bot` scope with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). Setting the target audience requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */ audience?: string | null; } @@ -389,6 +389,23 @@ export namespace chat_v1 { */ spaceDataSource?: Schema$SpaceDataSource; } + /** + * Data for Chat space links. + */ + export interface Schema$ChatSpaceLinkData { + /** + * The message of the linked Chat space resource. Format: `spaces/{space\}/messages/{message\}` + */ + message?: string | null; + /** + * The space of the linked Chat space resource. Format: `spaces/{space\}` + */ + space?: string | null; + /** + * The thread of the linked Chat space resource. Format: `spaces/{space\}/threads/{thread\}` + */ + thread?: string | null; + } /** * Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); \} public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); \} return resultBuilder.build(); \} // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; \} return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; \} static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; \} Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; \} [result autorelease]; return result; \} // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); \} var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); \}; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); \} resultBuilder.push(hexString); return resultBuilder.join(''); \}; // ... */ @@ -762,7 +779,7 @@ export namespace chat_v1 { */ peekCardHeader?: Schema$GoogleAppsCardV1CardHeader; /** - * The divider style between sections. + * The divider style between the header, sections and footer. */ sectionDividerStyle?: string | null; /** @@ -843,7 +860,7 @@ export namespace chat_v1 { widgets?: Schema$GoogleAppsCardV1Widgets[]; } /** - * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): + * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than two columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): The add-on UIs that support columns include: * The dialog displayed when users open the add-on from an email draft. * The dialog displayed when users open the add-on from the **Add attachment** menu in a Google Calendar event. */ export interface Schema$GoogleAppsCardV1Columns { /** @@ -1599,7 +1616,7 @@ export namespace chat_v1 { */ deleteTime?: string | null; /** - * The Google Group the membership corresponds to. + * The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */ groupMember?: Schema$Group; /** @@ -1647,7 +1664,7 @@ export namespace chat_v1 { memberships?: Schema$MembershipUpdatedEventData[]; } /** - * [Developer Preview](https://developers.google.com/workspace/preview). Represents the count of memberships of a space, grouped into categories. + * Represents the count of memberships of a space, grouped into categories. */ export interface Schema$MembershipCount { /** @@ -1763,7 +1780,7 @@ export namespace chat_v1 { */ name?: string | null; /** - * Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. Link previews and attachments aren't supported for private messages. Only Chat apps can send private messages. If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) to send a message, the message can't be private and must omit this field. For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private). + * Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and omit the following: * [Attachments](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages.attachments) * [Accessory widgets](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages#Message.AccessoryWidget) For details, see [Send a message privately](https://developers.google.com/workspace/chat/create-messages#private). */ privateMessageViewer?: Schema$User; /** @@ -1871,6 +1888,56 @@ export namespace chat_v1 { */ url?: string | null; } + /** + * Represents a space permission setting. + */ + export interface Schema$PermissionSetting { + /** + * Whether spaces managers have this permission. + */ + managersAllowed?: boolean | null; + /** + * Whether non-manager members have this permission. + */ + membersAllowed?: boolean | null; + } + /** + * [Permission settings](https://support.google.com/chat/answer/13340792) for a named space. To set permission settings when creating a space, specify the `PredefinedPermissionSettings` field in your request. + */ + export interface Schema$PermissionSettings { + /** + * Setting for managing apps in a space. + */ + manageApps?: Schema$PermissionSetting; + /** + * Setting for managing members and groups in a space. + */ + manageMembersAndGroups?: Schema$PermissionSetting; + /** + * Setting for managing webhooks in a space. + */ + manageWebhooks?: Schema$PermissionSetting; + /** + * Setting for updating space name, avatar, description and guidelines. + */ + modifySpaceDetails?: Schema$PermissionSetting; + /** + * Output only. Setting for posting messages in a space. + */ + postMessages?: Schema$PermissionSetting; + /** + * Setting for replying to messages in a space. + */ + replyMessages?: Schema$PermissionSetting; + /** + * Setting for toggling space history on and off. + */ + toggleHistory?: Schema$PermissionSetting; + /** + * Setting for using @all in a space. + */ + useAtMentionAll?: Schema$PermissionSetting; + } /** * Information about a quoted message. */ @@ -1941,6 +2008,10 @@ export namespace chat_v1 { * A rich link to a resource. */ export interface Schema$RichLinkMetadata { + /** + * Data for a chat space link. + */ + chatSpaceLinkData?: Schema$ChatSpaceLinkData; /** * Data for a drive link. */ @@ -2061,7 +2132,7 @@ export namespace chat_v1 { */ createTime?: string | null; /** - * The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. + * The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create) with a `spaceType` of `SPACE`. If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. */ displayName?: string | null; /** @@ -2069,21 +2140,29 @@ export namespace chat_v1 { */ externalUserAllowed?: boolean | null; /** - * Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. + * Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. Creating a space in `Import Mode`requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). */ importMode?: boolean | null; /** - * Output only. Timestamp of the last message in the space. [Developer Preview](https://developers.google.com/workspace/preview). + * Output only. Timestamp of the last message in the space. */ lastActiveTime?: string | null; /** - * Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. [Developer Preview](https://developers.google.com/workspace/preview). + * Output only. The count of joined memberships grouped by member type. Populated when the `space_type` is `SPACE`, `DIRECT_MESSAGE` or `GROUP_CHAT`. */ membershipCount?: Schema$MembershipCount; /** * Resource name of the space. Format: `spaces/{space\}` Where `{space\}` represents the system-assigned ID for the space. You can obtain the space ID by calling the [`spaces.list()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/list) method or from the space URL. For example, if the space URL is `https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA`, the space ID is `AAAAAAAAA`. */ name?: string | null; + /** + * Optional. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, use `predefined_permission_settings` instead. + */ + permissionSettings?: Schema$PermissionSettings; + /** + * Optional. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the `PermissionSettings` field. + */ + predefinedPermissionSettings?: string | null; /** * Optional. Whether the space is a DM between a Chat app and a single human. */ @@ -2780,7 +2859,7 @@ export namespace chat_v1 { } /** - * Creates a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Creates a space with no members. Can be used to create a named space. Spaces grouped by topics aren't supported. For an example, see [Create a space](https://developers.google.com/workspace/chat/create-spaces). If you receive the error message `ALREADY_EXISTS` when creating a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. If you're a member of the [Developer Preview program](https://developers.google.com/workspace/preview), you can create a group chat in import mode using `spaceType.GROUP_CHAT`. 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) When authenticating as an app, the `space.customer` field must be set in the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2864,7 +2943,7 @@ export namespace chat_v1 { } /** - * Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) from a user who has permission to delete the space. + * Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see [Delete a space](https://developers.google.com/workspace/chat/delete-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [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) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2948,7 +3027,7 @@ export namespace chat_v1 { } /** - * Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) or [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app). + * Returns the existing direct message with the specified user. If no direct message space is found, returns a `404 NOT_FOUND` error. For an example, see [Find a direct message](/chat/api/guides/v1/spaces/find-direct-message). With [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app), returns the direct message space between the specified user and the calling Chat app. With [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), returns the direct message space between the specified user and the authenticated user. // Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [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`. @@ -3036,7 +3115,7 @@ export namespace chat_v1 { } /** - * Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Returns details about a space. For an example, see [Get details about a space](https://developers.google.com/workspace/chat/get-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [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`. @@ -3120,7 +3199,7 @@ export namespace chat_v1 { } /** - * Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead. + * Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see [List spaces](https://developers.google.com/workspace/chat/list-spaces). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Lists spaces visible to the caller or authenticated user. Group chats and DMs aren't listed until the first message is sent. To list all named spaces by Google Workspace organization, use the [`spaces.search()`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/search) method using Workspace administrator privileges instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3207,7 +3286,7 @@ export namespace chat_v1 { } /** - * Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Updates a space. For an example, see [Update a space](https://developers.google.com/workspace/chat/update-spaces). If you're updating the `displayName` field and receive the error message `ALREADY_EXISTS`, try a different display name.. An existing space within the Google Workspace organization might already use this display name. 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) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3291,7 +3370,7 @@ export namespace chat_v1 { } /** - * [Developer Preview](https://developers.google.com/workspace/preview). Returns a list of spaces based on a user's search. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). The user must be an administrator for the Google Workspace organization. In the request, set `use_admin_access` to `true`. + * Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires [user authentication with administrator privileges](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user#admin-privileges). In the request, set `use_admin_access` to `true`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3493,7 +3572,7 @@ export namespace chat_v1 { */ name?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.delete` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). */ useAdminAccess?: boolean; } @@ -3510,7 +3589,7 @@ export namespace chat_v1 { */ name?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` or `chat.admin.spaces.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). */ useAdminAccess?: boolean; } @@ -3534,11 +3613,11 @@ export namespace chat_v1 { */ name?: string; /** - * Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + * - Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. */ updateMask?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. */ useAdminAccess?: boolean; @@ -3583,7 +3662,7 @@ export namespace chat_v1 { } /** - * Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). + * Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. 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) For example usage, see: - [Invite or add a user to a space](https://developers.google.com/workspace/chat/create-members#create-user-membership). - [Invite or add a Google Group to a space](https://developers.google.com/workspace/chat/create-members#create-group-membership). - [Add the Chat app to a space](https://developers.google.com/workspace/chat/create-members#create-membership-calling-api). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3671,7 +3750,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). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * 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) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3756,7 +3835,7 @@ export namespace chat_v1 { } /** - * Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-members). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Returns details about a membership. For an example, see [Get details about a user's or Google Chat app's membership](https://developers.google.com/workspace/chat/get-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) - [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`. @@ -3841,7 +3920,7 @@ export namespace chat_v1 { } /** - * Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Lists memberships in a space. For an example, see [List users and Google Chat apps in a space](https://developers.google.com/workspace/chat/list-members). Listing memberships with [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) lists memberships in spaces that the authenticated user has access to. 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) - [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`. @@ -3934,7 +4013,7 @@ export namespace chat_v1 { } /** - * Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-members). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). + * Updates a membership. For an example, see [Update a user's membership in a space](https://developers.google.com/workspace/chat/update-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) * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4026,7 +4105,7 @@ export namespace chat_v1 { */ parent?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. */ useAdminAccess?: boolean; @@ -4042,25 +4121,25 @@ export namespace chat_v1 { */ name?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access. + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Deleting app memberships in a space isn't supported using admin access. */ useAdminAccess?: boolean; } export interface Params$Resource$Spaces$Members$Get extends StandardParameters { /** - * Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space\}/members/app`. Format: `spaces/{space\}/members/{member\}` or `spaces/{space\}/members/app` When [authenticated as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can use the user's 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. + * Required. Resource name of the membership to retrieve. To get the app's own membership [by using user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), you can optionally use `spaces/{space\}/members/app`. Format: `spaces/{space\}/members/{member\}` or `spaces/{space\}/members/app` You can use the user's 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. */ name?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access. + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` or `chat.admin.memberships.readonly` [OAuth 2.0 scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Getting app memberships in a space isn't supported when using admin access. */ useAdminAccess?: boolean; } export interface Params$Resource$Spaces$Members$List extends StandardParameters { /** - * Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. Developer Preview: You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. + * Optional. A query filter. You can filter memberships by a member's role ([`role`](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members#membershiprole)) and type ([`member.type`](https://developers.google.com/workspace/chat/api/reference/rest/v1/User#type)). To filter by role, set `role` to `ROLE_MEMBER` or `ROLE_MANAGER`. To filter by type, set `member.type` to `HUMAN` or `BOT`. You can also filter for `member.type` using the `!=` operator. To filter by both role and type, use the `AND` operator. To filter by either role or type, use the `OR` operator. Either `member.type = "HUMAN"` or `member.type != "BOT"` is required when `use_admin_access` is set to true. Other member type filters will be rejected. For example, the following queries are valid: ``` role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT" ``` The following queries are invalid: ``` member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER" ``` Invalid queries are rejected by the server with an `INVALID_ARGUMENT` error. */ filter?: string; /** @@ -4084,7 +4163,7 @@ export namespace chat_v1 { */ showInvited?: boolean; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access. + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires either the `chat.admin.memberships.readonly` or `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Listing app memberships in a space isn't supported when using admin access. */ useAdminAccess?: boolean; } @@ -4099,7 +4178,7 @@ export namespace chat_v1 { */ updateMask?: string; /** - * [Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). + * When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). */ useAdminAccess?: boolean; @@ -4208,7 +4287,7 @@ export namespace chat_v1 { } /** - * Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only delete messages created by the calling Chat app. + * Deletes a message. For an example, see [Delete a message](https://developers.google.com/workspace/chat/delete-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only delete messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4293,7 +4372,7 @@ export namespace chat_v1 { } /** - * Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). Note: Might return a message from a blocked member or space. + * Returns details about a message. For an example, see [Get details about a message](https://developers.google.com/workspace/chat/get-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) Note: Might return a message from a blocked member or space. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4471,7 +4550,7 @@ export namespace chat_v1 { } /** - * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app. + * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4556,7 +4635,7 @@ export namespace chat_v1 { } /** - * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Requires [authentication](https://developers.google.com/workspace/chat/authenticate-authorize). Supports [app authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) and [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user). When using app authentication, requests can only update messages created by the calling Chat app. + * Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) When using app authentication, requests can only update messages created by the calling Chat app. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/checks/v1alpha.ts b/src/apis/checks/v1alpha.ts index 7af637b284..878fb71eb2 100644 --- a/src/apis/checks/v1alpha.ts +++ b/src/apis/checks/v1alpha.ts @@ -754,9 +754,11 @@ export namespace checks_v1alpha { export class Resource$Accounts { context: APIRequestContext; apps: Resource$Accounts$Apps; + repos: Resource$Accounts$Repos; constructor(context: APIRequestContext) { this.context = context; this.apps = new Resource$Accounts$Apps(this.context); + this.repos = new Resource$Accounts$Repos(this.context); } } @@ -1722,6 +1724,115 @@ export namespace checks_v1alpha { parent?: string; } + export class Resource$Accounts$Repos { + context: APIRequestContext; + operations: Resource$Accounts$Repos$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Accounts$Repos$Operations(this.context); + } + } + + export class Resource$Accounts$Repos$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Repos$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Repos$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Repos$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Repos$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Repos$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Repos$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Repos$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Repos$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://checks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Repos$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export class Resource$Media { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/chromeuxreport/v1.ts b/src/apis/chromeuxreport/v1.ts index 49cd22cfb6..03c54c2534 100644 --- a/src/apis/chromeuxreport/v1.ts +++ b/src/apis/chromeuxreport/v1.ts @@ -131,7 +131,7 @@ export namespace chromeuxreport_v1 { /** * The proportion of users that experienced this bin's value for the given metric. */ - density?: number | null; + density?: any | null; /** * End is the end of the data bin. If end is not populated, then the bin has no end and is valid from start to +inf. */ diff --git a/src/apis/civicinfo/v2.ts b/src/apis/civicinfo/v2.ts index c5243512ed..2aadfc4d6d 100644 --- a/src/apis/civicinfo/v2.ts +++ b/src/apis/civicinfo/v2.ts @@ -365,6 +365,13 @@ 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. */ @@ -797,6 +804,101 @@ export namespace civicinfo_v2 { this.context = context; } + /** + * Lookup OCDIDs and names for divisions related to an address. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + queryDivisionByAddress( + params: Params$Resource$Divisions$Querydivisionbyaddress, + options: StreamMethodOptions + ): GaxiosPromise; + queryDivisionByAddress( + params?: Params$Resource$Divisions$Querydivisionbyaddress, + options?: MethodOptions + ): GaxiosPromise; + queryDivisionByAddress( + params: Params$Resource$Divisions$Querydivisionbyaddress, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDivisionByAddress( + params: Params$Resource$Divisions$Querydivisionbyaddress, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + queryDivisionByAddress( + params: Params$Resource$Divisions$Querydivisionbyaddress, + callback: BodyResponseCallback + ): void; + queryDivisionByAddress( + callback: BodyResponseCallback + ): void; + queryDivisionByAddress( + paramsOrCallback?: + | Params$Resource$Divisions$Querydivisionbyaddress + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Divisions$Querydivisionbyaddress; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Divisions$Querydivisionbyaddress; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://civicinfo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/civicinfo/v2/divisionsByAddress').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Searches for political divisions by their natural name or OCD ID. * @@ -890,6 +992,13 @@ export namespace civicinfo_v2 { } } + export interface Params$Resource$Divisions$Querydivisionbyaddress + extends StandardParameters { + /** + * + */ + address?: string; + } export interface Params$Resource$Divisions$Search extends StandardParameters { /** * The search query. Queries can cover any parts of a OCD ID or a human readable division name. All words given in the query are treated as required patterns. In addition to that, most query operators of the Apache Lucene library are supported. See http://lucene.apache.org/core/2_9_4/queryparsersyntax.html diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 46dbd8b07b..0f24390d9f 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -155,7 +155,7 @@ export namespace classroom_v1 { */ id?: string | null; /** - * Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. Unique per course. + * Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. Unique per course. */ itemId?: string | null; /** @@ -163,19 +163,19 @@ export namespace classroom_v1 { */ maxPoints?: number | null; /** - * Immutable. Deprecated, use item_id instead. + * Immutable. Deprecated, use `item_id` instead. */ postId?: string | null; /** - * Required. URI to show the student view of the attachment. The URI will be opened in an iframe with the `courseId`, `postId`, and `attachmentId` query parameters set. + * Required. URI to show the student view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set. */ studentViewUri?: Schema$EmbedUri; /** - * URI for the teacher to see student work on the attachment, if applicable. The URI will be opened in an iframe with the `courseId`, `postId`, `attachmentId`, and `submissionId` query parameters set. This is the same `submissionId` returned by google.classroom.AddOns.GetAddOnContext when a student views the attachment. If the URI is omitted or removed, `max_points` will also be discarded. + * URI for the teacher to see student work on the attachment, if applicable. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, `attachmentId`, and `submissionId` query parameters set. This is the same `submissionId` returned in the [`AddOnContext.studentContext`](//devsite.google.com/classroom/reference/rest/v1/AddOnContext#StudentContext) field when a student views the attachment. If the URI is omitted or removed, `max_points` will also be discarded. */ studentWorkReviewUri?: Schema$EmbedUri; /** - * Required. URI to show the teacher view of the attachment. The URI will be opened in an iframe with the `courseId`, `postId`, and `attachmentId` query parameters set. + * Required. URI to show the teacher view of the attachment. The URI will be opened in an iframe with the `courseId`, `itemId`, `itemType`, and `attachmentId` query parameters set. */ teacherViewUri?: Schema$EmbedUri; /** @@ -205,11 +205,11 @@ export namespace classroom_v1 { */ courseId?: string | null; /** - * Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. + * Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. */ itemId?: string | null; /** - * Immutable. Deprecated, use item_id instead. + * Immutable. Deprecated, use `item_id` instead. */ postId?: string | null; /** @@ -339,11 +339,11 @@ export namespace classroom_v1 { */ courseId?: string | null; /** - * Immutable. Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. + * Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. */ itemId?: string | null; /** - * Immutable. Deprecated, use item_id instead. + * Immutable. Deprecated, use `item_id` instead. */ postId?: string | null; } @@ -3088,11 +3088,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -3628,11 +3628,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; @@ -3652,11 +3652,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -3671,11 +3671,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -3686,7 +3686,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** @@ -3698,7 +3698,7 @@ export namespace classroom_v1 { */ pageToken?: string; /** - * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead. + * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead. */ postId?: string; } @@ -4414,11 +4414,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -4957,11 +4957,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; @@ -4981,11 +4981,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -5000,11 +5000,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -5015,7 +5015,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** @@ -5027,7 +5027,7 @@ export namespace classroom_v1 { */ pageToken?: string; /** - * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead. + * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead. */ postId?: string; } @@ -5274,11 +5274,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; /** @@ -5297,11 +5297,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; /** @@ -6721,11 +6721,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7253,11 +7253,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; @@ -7277,11 +7277,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7296,11 +7296,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7311,7 +7311,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** @@ -7323,7 +7323,7 @@ export namespace classroom_v1 { */ pageToken?: string; /** - * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead. + * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7469,11 +7469,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7948,11 +7948,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which to create the attachment. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; @@ -7972,11 +7972,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -7991,11 +7991,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; } @@ -8006,7 +8006,7 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` whose attachments should be enumerated. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** @@ -8018,7 +8018,7 @@ export namespace classroom_v1 { */ pageToken?: string; /** - * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use item_id instead. + * Optional. Identifier of the post under the course whose attachments to enumerate. Deprecated, use `item_id` instead. */ postId?: string; } @@ -8265,11 +8265,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; /** @@ -8288,11 +8288,11 @@ export namespace classroom_v1 { */ courseId?: string; /** - * Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. + * Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. */ itemId?: string; /** - * Optional. Deprecated, use item_id instead. + * Optional. Deprecated, use `item_id` instead. */ postId?: string; /** diff --git a/src/apis/cloudbilling/v1beta.ts b/src/apis/cloudbilling/v1beta.ts index fdb0a6457c..1eb1baef6d 100644 --- a/src/apis/cloudbilling/v1beta.ts +++ b/src/apis/cloudbilling/v1beta.ts @@ -212,7 +212,7 @@ export namespace cloudbilling_v1beta { provisionedLinkCount?: Schema$Usage; } /** - * Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. + * Specification of a network type. Network data transfer within Google Cloud applies when you move or copy data from one Cloud Storage bucket to another or when another Google Cloud service accesses data in your Cloud Storage bucket.This includes the network data transfer within Google Cloud and the general network usage. * If transferring data between two regions, the source and destination fields are set to different values. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_SOUTH_AMERICA". * If transferring data within one region, the source and destination fields are set to the same value. For example: `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". Some examples for the Network data transfer traffic type on the pricing page. * Data moves between different locations on the same continent. `source_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and neither is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_ASIA_PACIFIC". * Data moves between different continents and one is Australia. `source_continent` = "SOURCE_CONTINENT_NORTH_AMERICA", `destination_continent` = "SOURCE_CONTINENT_AUSTRALIA". */ export interface Schema$CloudStorageEgressWorkload { /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 63dffae3db..b74c6653f6 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -836,7 +836,7 @@ export namespace cloudbuild_v1 { */ resourceName?: string | null; /** - * The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL\}` + * The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set and the legacy Cloud Build service account ([PROJECT_NUM]@cloudbuild.gserviceaccount.com) is the default for the project then it will be used instead. Format: `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL\}` */ serviceAccount?: string | null; /** diff --git a/src/apis/cloudchannel/v1.ts b/src/apis/cloudchannel/v1.ts index ae571a2a80..c31a0d5173 100644 --- a/src/apis/cloudchannel/v1.ts +++ b/src/apis/cloudchannel/v1.ts @@ -113,7 +113,6 @@ export namespace cloudchannel_v1 { export class Cloudchannel { context: APIRequestContext; accounts: Resource$Accounts; - integrators: Resource$Integrators; operations: Resource$Operations; products: Resource$Products; @@ -124,7 +123,6 @@ export namespace cloudchannel_v1 { }; this.accounts = new Resource$Accounts(this.context); - this.integrators = new Resource$Integrators(this.context); this.operations = new Resource$Operations(this.context); this.products = new Resource$Products(this.context); } @@ -757,11 +755,11 @@ export namespace cloudchannel_v1 { */ export interface Schema$GoogleCloudChannelV1CheckCloudIdentityAccountsExistRequest { /** - * Required. Domain to fetch for Cloud Identity account customers, including domained and domainless. + * Required. Domain to fetch for Cloud Identity account customers, including domain and team customers. For team customers, please use the domain for their emails. */ domain?: string | null; /** - * Optional. Primary admin email to fetch for Cloud Identity account domainless customer. + * Optional. Primary admin email to fetch for Cloud Identity account team customer. */ primaryAdminEmail?: string | null; } @@ -1270,7 +1268,7 @@ export namespace cloudchannel_v1 { */ overwriteIfExists?: boolean | null; /** - * Optional. Customer's primary admin email. + * Required. Customer's primary admin email. */ primaryAdminEmail?: string | null; } @@ -1900,10 +1898,6 @@ export namespace cloudchannel_v1 { * Request Message for RegisterSubscriber. */ export interface Schema$GoogleCloudChannelV1RegisterSubscriberRequest { - /** - * Optional. Resource name of the integrator. - */ - integrator?: string | null; /** * Required. Service account that provides subscriber access to the registered topic. */ @@ -2325,10 +2319,6 @@ export namespace cloudchannel_v1 { * Request Message for UnregisterSubscriber. */ export interface Schema$GoogleCloudChannelV1UnregisterSubscriberRequest { - /** - * Optional. Resource name of the integrator. - */ - integrator?: string | null; /** * Required. Service account to unregister from subscriber access to the topic. */ @@ -3211,10 +3201,6 @@ export namespace cloudchannel_v1 { * Optional. Resource name of the account. */ account?: string; - /** - * Optional. Resource name of the integrator. - */ - integrator?: string; /** * Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. */ @@ -8826,354 +8812,6 @@ export namespace cloudchannel_v1 { parent?: string; } - export class Resource$Integrators { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - listSubscribers( - params: Params$Resource$Integrators$Listsubscribers, - options: StreamMethodOptions - ): GaxiosPromise; - listSubscribers( - params?: Params$Resource$Integrators$Listsubscribers, - options?: MethodOptions - ): GaxiosPromise; - listSubscribers( - params: Params$Resource$Integrators$Listsubscribers, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listSubscribers( - params: Params$Resource$Integrators$Listsubscribers, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listSubscribers( - params: Params$Resource$Integrators$Listsubscribers, - callback: BodyResponseCallback - ): void; - listSubscribers( - callback: BodyResponseCallback - ): void; - listSubscribers( - paramsOrCallback?: - | Params$Resource$Integrators$Listsubscribers - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Integrators$Listsubscribers; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Integrators$Listsubscribers; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+integrator}:listSubscribers').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['integrator'], - pathParams: ['integrator'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - register( - params: Params$Resource$Integrators$Register, - options: StreamMethodOptions - ): GaxiosPromise; - register( - params?: Params$Resource$Integrators$Register, - options?: MethodOptions - ): GaxiosPromise; - register( - params: Params$Resource$Integrators$Register, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - register( - params: Params$Resource$Integrators$Register, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - register( - params: Params$Resource$Integrators$Register, - callback: BodyResponseCallback - ): void; - register( - callback: BodyResponseCallback - ): void; - register( - paramsOrCallback?: - | Params$Resource$Integrators$Register - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Integrators$Register; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Integrators$Register; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+integrator}:register').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['integrator'], - pathParams: ['integrator'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - unregister( - params: Params$Resource$Integrators$Unregister, - options: StreamMethodOptions - ): GaxiosPromise; - unregister( - params?: Params$Resource$Integrators$Unregister, - options?: MethodOptions - ): GaxiosPromise; - unregister( - params: Params$Resource$Integrators$Unregister, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - unregister( - params: Params$Resource$Integrators$Unregister, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - unregister( - params: Params$Resource$Integrators$Unregister, - callback: BodyResponseCallback - ): void; - unregister( - callback: BodyResponseCallback - ): void; - unregister( - paramsOrCallback?: - | Params$Resource$Integrators$Unregister - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Integrators$Unregister; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Integrators$Unregister; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+integrator}:unregister').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['integrator'], - pathParams: ['integrator'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Integrators$Listsubscribers - extends StandardParameters { - /** - * Optional. Resource name of the account. - */ - account?: string; - /** - * Optional. Resource name of the integrator. - */ - integrator?: string; - /** - * Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Integrators$Register - extends StandardParameters { - /** - * Optional. Resource name of the account. - */ - account?: string; - /** - * Optional. Resource name of the integrator. - */ - integrator?: string; - /** - * Required. Service account that provides subscriber access to the registered topic. - */ - serviceAccount?: string; - } - export interface Params$Resource$Integrators$Unregister - extends StandardParameters { - /** - * Optional. Resource name of the account. - */ - account?: string; - /** - * Optional. Resource name of the integrator. - */ - integrator?: string; - /** - * Required. Service account to unregister from subscriber access to the topic. - */ - serviceAccount?: string; - } - export class Resource$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/cloudcontrolspartner/v1.ts b/src/apis/cloudcontrolspartner/v1.ts index ac8b180208..849b5ff4f3 100644 --- a/src/apis/cloudcontrolspartner/v1.ts +++ b/src/apis/cloudcontrolspartner/v1.ts @@ -197,7 +197,7 @@ export namespace cloudcontrolspartner_v1 { */ customerOnboardingState?: Schema$CustomerOnboardingState; /** - * The customer organization's display name. E.g. "Google". + * Required. Display name for the customer */ displayName?: string | null; /** diff --git a/src/apis/cloudcontrolspartner/v1beta.ts b/src/apis/cloudcontrolspartner/v1beta.ts index a482427368..3f9c833577 100644 --- a/src/apis/cloudcontrolspartner/v1beta.ts +++ b/src/apis/cloudcontrolspartner/v1beta.ts @@ -197,7 +197,7 @@ export namespace cloudcontrolspartner_v1beta { */ customerOnboardingState?: Schema$CustomerOnboardingState; /** - * The customer organization's display name. E.g. "Google". + * Required. Display name for the customer */ displayName?: string | null; /** diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 5046363504..3c4496fae3 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -174,6 +174,10 @@ export namespace clouddeploy_v1 { * The request object used by `AdvanceRollout`. */ export interface Schema$AdvanceRolloutRequest { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; /** * Required. The phase ID to advance the `Rollout` to. */ @@ -221,6 +225,10 @@ export namespace clouddeploy_v1 { * Required. True = approve; false = reject */ approved?: boolean | null; + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; } /** * The response object from `ApproveRollout`. @@ -410,6 +418,10 @@ export namespace clouddeploy_v1 { * Output only. Name of the `AutomationRun`. Format is `projects/{project\}/locations/{location\}/deliveryPipelines/{delivery_pipeline\}/automationRuns/{automation_run\}`. */ name?: string | null; + /** + * Output only. Contains information about what policies prevented the `AutomationRun` from proceeding. + */ + policyViolation?: Schema$PolicyViolation; /** * Output only. Promotes a release to a specified 'Target'. */ @@ -563,7 +575,12 @@ export namespace clouddeploy_v1 { /** * The request object used by `CancelRollout`. */ - export interface Schema$CancelRolloutRequest {} + export interface Schema$CancelRolloutRequest { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; + } /** * The response object from `CancelRollout`. */ @@ -873,6 +890,19 @@ export namespace clouddeploy_v1 { */ updateTime?: string | null; } + /** + * Contains criteria for selecting DeliveryPipelines. + */ + export interface Schema$DeliveryPipelineAttribute { + /** + * ID of the `DeliveryPipeline`. The value of this field could be one of the following: * The last segment of a pipeline name * "*", all delivery pipelines in a location + */ + id?: string | null; + /** + * DeliveryPipeline labels. + */ + labels?: {[key: string]: string} | null; + } /** * Payload proto for "clouddeploy.googleapis.com/deliverypipeline_notification" Platform Log event that describes the failure to send delivery pipeline status change Pub/Sub notification. */ @@ -987,6 +1017,112 @@ export namespace clouddeploy_v1 { */ values?: {[key: string]: string} | null; } + /** + * A `DeployPolicy` resource in the Cloud Deploy API. A `DeployPolicy` inhibits manual or automation-driven actions within a Delivery Pipeline or Target. + */ + export interface Schema$DeployPolicy { + /** + * User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. Annotations must meet the following constraints: * Annotations are key/value pairs. * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (`/`). * The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character (`[a-z0-9A-Z]`) with dashes (`-`), underscores (`_`), dots (`.`), and alphanumerics between. * The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots(`.`), not longer than 253 characters in total, followed by a slash (`/`). See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/#syntax-and-character-set for more details. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. Time at which the deploy policy was created. + */ + createTime?: string | null; + /** + * Description of the `DeployPolicy`. Max length is 255 characters. + */ + 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. + */ + etag?: string | null; + /** + * Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Name of the `DeployPolicy`. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?` + */ + name?: string | null; + /** + * Required. Rules to apply. At least one rule must be present. + */ + rules?: Schema$PolicyRule[]; + /** + * Required. Selected resources to which the policy will be applied. At least one selector is required. If one selector matches the resource the policy applies. For example, if there are two selectors and the action being attempted matches one of them, the policy will apply to that action. + */ + selectors?: Schema$DeployPolicyResourceSelector[]; + /** + * When suspended, the policy will not prevent actions from occurring, even if the action violates the policy. + */ + suspended?: boolean | null; + /** + * Output only. Unique identifier of the `DeployPolicy`. + */ + uid?: string | null; + /** + * Output only. Most recent time at which the deploy policy was updated. + */ + updateTime?: string | null; + } + /** + * Payload proto for "clouddeploy.googleapis.com/deploypolicy_evaluation" Platform Log event that describes the deploy policy evaluation event. + */ + export interface Schema$DeployPolicyEvaluationEvent { + /** + * Whether the request is allowed. Allowed is set as true if: (1) the request complies with the policy; or (2) the request doesn't comply with the policy but the policy was overridden; or (3) the request doesn't comply with the policy but the policy was suspended + */ + allowed?: boolean | null; + /** + * The name of the `Delivery Pipeline`. + */ + deliveryPipeline?: string | null; + /** + * The name of the `DeployPolicy`. + */ + deployPolicy?: string | null; + /** + * Unique identifier of the `DeployPolicy`. + */ + deployPolicyUid?: string | null; + /** + * What invoked the action (e.g. a user or automation). + */ + invoker?: string | null; + /** + * Debug message for when a deploy policy event occurs. + */ + message?: string | null; + /** + * Things that could have overridden the policy verdict. Overrides together with verdict decide whether the request is allowed. + */ + overrides?: string[] | null; + /** + * Unique identifier of the `Delivery Pipeline`. + */ + pipelineUid?: string | null; + /** + * Rule id. + */ + rule?: string | null; + /** + * Rule type (e.g. Restrict Rollouts). + */ + ruleType?: string | null; + /** + * The name of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy. + */ + target?: string | null; + /** + * Unique identifier of the `Target`. This is an optional field, as a `Target` may not always be applicable to a policy. + */ + targetUid?: string | null; + /** + * The policy verdict of the request. + */ + verdict?: string | null; + } /** * Payload proto for "clouddeploy.googleapis.com/deploypolicy_notification". Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change. */ @@ -1008,6 +1144,19 @@ export namespace clouddeploy_v1 { */ type?: string | null; } + /** + * Contains information on the resources to select for a deploy policy. Attributes provided must all match the resource in order for policy restrictions to apply. For example, if delivery pipelines attributes given are an id "prod" and labels "foo: bar", a delivery pipeline resource must match both that id and have that label in order to be subject to the policy. + */ + export interface Schema$DeployPolicyResourceSelector { + /** + * Optional. Contains attributes about a delivery pipeline. + */ + deliveryPipeline?: Schema$DeliveryPipelineAttribute; + /** + * Optional. Contains attributes about a target. + */ + target?: Schema$TargetAttribute; + } /** * 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); \} */ @@ -1124,6 +1273,10 @@ export namespace clouddeploy_v1 { * Required. The job ID for the Job to ignore. */ jobId?: string | null; + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; /** * Required. The phase ID the Job to ignore belongs to. */ @@ -1365,6 +1518,23 @@ export namespace clouddeploy_v1 { */ unreachable?: string[] | null; } + /** + * The response object from `ListDeployPolicies`. + */ + export interface Schema$ListDeployPoliciesResponse { + /** + * The `DeployPolicy` objects. + */ + deployPolicies?: Schema$DeployPolicy[]; + /** + * 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; + } /** * ListJobRunsResponse is the response object returned by `ListJobRuns`. */ @@ -1510,6 +1680,27 @@ export namespace clouddeploy_v1 { */ targetIds?: string[] | null; } + /** + * One-time window within which actions are restricted. For example, blocking actions over New Year's Eve from December 31st at 5pm to January 1st at 9am. + */ + export interface Schema$OneTimeWindow { + /** + * Required. End date. + */ + endDate?: Schema$Date; + /** + * Required. End time (exclusive). You may use 24:00 for the end of the day. + */ + endTime?: Schema$TimeOfDay; + /** + * Required. Start date. + */ + startDate?: Schema$Date; + /** + * Required. Start time (inclusive). Use 00:00 for the beginning of the day. + */ + startTime?: Schema$TimeOfDay; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1690,6 +1881,41 @@ export namespace clouddeploy_v1 { */ version?: number | null; } + /** + * Deploy Policy rule. + */ + export interface Schema$PolicyRule { + /** + * Rollout restrictions. + */ + rolloutRestriction?: Schema$RolloutRestriction; + } + /** + * Returned from an action if one or more policies were violated, and therefore the action was prevented. Contains information about what policies were violated and why. + */ + export interface Schema$PolicyViolation { + /** + * Policy violation details. + */ + policyViolationDetails?: Schema$PolicyViolationDetails[]; + } + /** + * Policy violation details. + */ + export interface Schema$PolicyViolationDetails { + /** + * User readable message about why the request violated a policy. This is not intended for machine parsing. + */ + failureMessage?: string | null; + /** + * Name of the policy that was violated. Policy resource will be in the format of `projects/{project\}/locations/{location\}/policies/{policy\}`. + */ + policy?: string | null; + /** + * Id of the rule that triggered the policy violation. + */ + ruleId?: string | null; + } /** * Postdeploy contains the postdeploy job configuration information. */ @@ -2014,10 +2240,27 @@ export namespace clouddeploy_v1 { */ rollback?: Schema$RollbackAttempt; } + /** + * Configuration of the repair phase. + */ + export interface Schema$RepairPhaseConfig { + /** + * Optional. Retries a failed job. + */ + retry?: Schema$Retry; + /** + * Optional. Rolls back a `Rollout`. + */ + rollback?: Schema$Rollback; + } /** * Contains the information for an automated `repair rollout` operation. */ export interface Schema$RepairRolloutOperation { + /** + * Output only. The index of the current repair action in the repair sequence. + */ + currentRepairPhaseIndex?: string | null; /** * Output only. The job ID for the Job to repair. */ @@ -2051,6 +2294,31 @@ export namespace clouddeploy_v1 { * Optional. Jobs to repair. Proceeds only after job name matched any one in the list, or for all jobs if unspecified or empty. The phase that includes the job must match the phase ID specified in `source_phase`. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. */ jobs?: string[] | null; + /** + * Optional. Phases within which jobs are subject to automatic repair actions on failure. Proceeds only after phase name matched any one in the list, or for all phases if unspecified. This value must consist of lower-case letters, numbers, and hyphens, start with a letter and end with a letter or a number, and have a max length of 63 characters. In other words, it must match the following regex: `^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$`. + */ + phases?: string[] | null; + /** + * Required. Defines the types of automatic repair phases for failed jobs. + */ + repairPhases?: Schema$RepairPhaseConfig[]; + } + /** + * Retries the failed job. + */ + export interface Schema$Retry { + /** + * Required. Total number of retries. Retry is skipped if set to 0; The minimum value is 1, and the maximum value is 10. + */ + attempts?: string | null; + /** + * Optional. The pattern of how wait time will be increased. Default is linear. Backoff mode will be ignored if `wait` is 0. + */ + backoffMode?: string | null; + /** + * Optional. How long to wait for the first retry. Default is 0, and the maximum value is 14d. + */ + wait?: string | null; } /** * RetryAttempt represents an action of retrying the failed Cloud Deploy job. @@ -2081,6 +2349,10 @@ export namespace clouddeploy_v1 { * Required. The job ID for the Job to retry. */ jobId?: string | null; + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; /** * Required. The phase ID the Job to retry belongs to. */ @@ -2107,6 +2379,19 @@ export namespace clouddeploy_v1 { */ totalAttempts?: string | null; } + /** + * Rolls back a `Rollout`. + */ + export interface Schema$Rollback { + /** + * Optional. The starting phase ID for the `Rollout`. If unspecified, the `Rollout` will start in the stable phase. + */ + destinationPhase?: string | null; + /** + * Optional. If pending rollout exists on the target, the rollback operation will be aborted. + */ + disableRollbackIfRolloutPending?: boolean | null; + } /** * RollbackAttempt represents an action of rolling back a Cloud Deploy 'Target'. */ @@ -2115,6 +2400,10 @@ export namespace clouddeploy_v1 { * Output only. The phase to which the rollout will be rolled back to. */ destinationPhase?: string | null; + /** + * Output only. If active rollout exists on the target, abort this rollback. + */ + disableRollbackIfRolloutPending?: boolean | null; /** * Output only. ID of the rollback `Rollout` to create. */ @@ -2145,6 +2434,10 @@ export namespace clouddeploy_v1 { * The request object for `RollbackTarget`. */ export interface Schema$RollbackTargetRequest { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deploy_policy\}`. + */ + overrideDeployPolicy?: string[] | null; /** * Optional. ID of the `Release` to roll back to. If this isn't specified, the previous successful `Rollout` to the specified target will be used to determine the `Release`. */ @@ -2183,6 +2476,10 @@ export namespace clouddeploy_v1 { * A `Rollout` resource in the Cloud Deploy API. A `Rollout` contains information around a specific deployment to a `Target`. */ export interface Schema$Rollout { + /** + * Output only. The AutomationRun actively repairing the rollout. + */ + activeRepairAutomationRun?: string | null; /** * User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. */ @@ -2309,6 +2606,27 @@ export namespace clouddeploy_v1 { */ type?: string | null; } + /** + * Rollout restrictions. + */ + export interface Schema$RolloutRestriction { + /** + * Optional. Rollout actions to be restricted as part of the policy. If left empty, all actions will be restricted. + */ + actions?: string[] | null; + /** + * Required. Restriction rule ID. Required and must be unique within a DeployPolicy. The format is `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?`. + */ + id?: string | null; + /** + * Optional. What invoked the action. If left empty, all invoker types will be restricted. + */ + invokers?: string[] | null; + /** + * Required. Time window within which actions are restricted. + */ + timeWindows?: Schema$TimeWindows; + } /** * Payload proto for "clouddeploy.googleapis.com/rollout_update" Platform Log event that describes the rollout update event. */ @@ -2675,7 +2993,7 @@ export namespace clouddeploy_v1 { skaffoldConfigPath?: string | null; } /** - * Contains criteria for selecting Targets. + * Contains criteria for selecting Targets. This could be used to select targets for a Deploy Policy or for an Automation. */ export interface Schema$TargetAttribute { /** @@ -2762,7 +3080,12 @@ export namespace clouddeploy_v1 { /** * The request object used by `TerminateJobRun`. */ - export interface Schema$TerminateJobRunRequest {} + export interface Schema$TerminateJobRunRequest { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[] | null; + } /** * The response object from `TerminateJobRun`. */ @@ -2785,6 +3108,44 @@ export namespace clouddeploy_v1 { */ permissions?: string[] | null; } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of hour of day. Must be from 0 to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Time windows within which actions are restricted. See the [documentation](https://cloud.google.com/deploy/docs/deploy-policy#dates_times) for more information on how to configure dates/times. + */ + export interface Schema$TimeWindows { + /** + * Optional. One-time windows within which actions are restricted. + */ + oneTimeWindows?: Schema$OneTimeWindow[]; + /** + * Required. The time zone in IANA format [IANA Time Zone Database](https://www.iana.org/time-zones) (e.g. America/New_York). + */ + timeZone?: string | null; + /** + * Optional. Recurring weekly windows within which actions are restricted. + */ + weeklyWindows?: Schema$WeeklyWindow[]; + } /** * A verify Job. */ @@ -2814,6 +3175,23 @@ export namespace clouddeploy_v1 { */ failureMessage?: string | null; } + /** + * Weekly windows. For example, blocking actions every Saturday and Sunday. Another example would be blocking actions every weekday from 5pm to midnight. + */ + export interface Schema$WeeklyWindow { + /** + * Optional. Days of week. If left empty, all days of the week will be included. + */ + daysOfWeek?: string[] | null; + /** + * Optional. End time (exclusive). Use 24:00 to indicate midnight. If you specify end_time you must also specify start_time. If left empty, this will block for the entire day for the days specified in days_of_week. + */ + endTime?: Schema$TimeOfDay; + /** + * Optional. Start time (inclusive). Use 00:00 for the beginning of the day. If you specify start_time you must also specify end_time. If left empty, this will block for the entire day for the days specified in days_of_week. + */ + startTime?: Schema$TimeOfDay; + } export class Resource$Projects { context: APIRequestContext; @@ -2828,6 +3206,7 @@ export namespace clouddeploy_v1 { context: APIRequestContext; customTargetTypes: Resource$Projects$Locations$Customtargettypes; deliveryPipelines: Resource$Projects$Locations$Deliverypipelines; + deployPolicies: Resource$Projects$Locations$Deploypolicies; operations: Resource$Projects$Locations$Operations; targets: Resource$Projects$Locations$Targets; constructor(context: APIRequestContext) { @@ -2836,6 +3215,9 @@ export namespace clouddeploy_v1 { new Resource$Projects$Locations$Customtargettypes(this.context); this.deliveryPipelines = new Resource$Projects$Locations$Deliverypipelines(this.context); + this.deployPolicies = new Resource$Projects$Locations$Deploypolicies( + this.context + ); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -6161,6 +6543,10 @@ export namespace clouddeploy_v1 { } export interface Params$Resource$Projects$Locations$Deliverypipelines$Releases$Create extends StandardParameters { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[]; /** * Required. The parent collection in which the `Release` is created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. */ @@ -6997,6 +7383,10 @@ export namespace clouddeploy_v1 { } export interface Params$Resource$Projects$Locations$Deliverypipelines$Releases$Rollouts$Create extends StandardParameters { + /** + * Optional. Deploy policies to override. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. + */ + overrideDeployPolicy?: string[]; /** * Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}/releases/{release_name\}`. */ @@ -7402,6 +7792,557 @@ export namespace clouddeploy_v1 { requestBody?: Schema$TerminateJobRunRequest; } + export class Resource$Projects$Locations$Deploypolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new DeployPolicy 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$Deploypolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Deploypolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Deploypolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Deploypolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Deploypolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://clouddeploy.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/deployPolicies').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 DeployPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deploypolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Deploypolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Deploypolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploypolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Deploypolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://clouddeploy.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 DeployPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Deploypolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Deploypolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Deploypolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deploypolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Deploypolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://clouddeploy.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 DeployPolicies 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$Deploypolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Deploypolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Deploypolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deploypolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Deploypolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://clouddeploy.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/deployPolicies').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 DeployPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Deploypolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deploypolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deploypolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploypolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploypolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploypolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploypolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deploypolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://clouddeploy.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$Deploypolicies$Create + extends StandardParameters { + /** + * Required. ID of the `DeployPolicy`. + */ + deployPolicyId?: string; + /** + * Required. The parent collection in which the `DeployPolicy` must be created. The format is `projects/{project_id\}/locations/{location_name\}`. + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that 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 to true, the request is validated and the user is provided with an expected result, but no actual change is made. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$DeployPolicy; + } + export interface Params$Resource$Projects$Locations$Deploypolicies$Delete + extends StandardParameters { + /** + * Optional. If set to true, then deleting an already deleted or non-existing `DeployPolicy` will succeed. + */ + allowMissing?: boolean; + /** + * 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. The name of the `DeployPolicy` to delete. The format is `projects/{project_id\}/locations/{location_name\}/deployPolicies/{deploy_policy_name\}`. + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that 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 review, but do not actually post it. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Deploypolicies$Get + extends StandardParameters { + /** + * Required. Name of the `DeployPolicy`. Format must be `projects/{project_id\}/locations/{location_name\}/deployPolicies/{deploy_policy_name\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Deploypolicies$List + extends StandardParameters { + /** + * Filter deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter. + */ + filter?: string; + /** + * Field to sort by. See https://google.aip.dev/132#ordering for more details. + */ + orderBy?: string; + /** + * The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies will be returned. The maximum value is 1000; values above 1000 will be set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListDeployPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of deploy policies. Format must be `projects/{project_id\}/locations/{location_name\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Deploypolicies$Patch + extends StandardParameters { + /** + * Optional. If set to true, updating a `DeployPolicy` that does not exist will result in the creation of a new `DeployPolicy`. + */ + allowMissing?: boolean; + /** + * Output only. Name of the `DeployPolicy`. Format is `projects/{project\}/locations/{location\}/deployPolicies/{deployPolicy\}`. The `deployPolicy` component must match `[a-z]([a-z0-9-]{0,61\}[a-z0-9])?` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that 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. Field mask is used to specify the fields to be overwritten by the update in the `DeployPolicy` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten. + */ + updateMask?: string; + /** + * Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$DeployPolicy; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 489648fb02..acaf13b509 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -429,330 +429,6 @@ export namespace cloudfunctions_v1 { */ uploadUrl?: string | null; } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2alphaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2alphaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2alphaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2alphaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2betaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2betaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2betaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2betaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2LocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2OperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2Stage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2Stage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2StateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2StateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } /** * Describes HttpsTrigger, could be used to connect web hooks to function. */ diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index ea433d2950..50d38fe12b 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -430,222 +430,6 @@ export namespace cloudfunctions_v2 { */ uploadUrl?: string | null; } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2alphaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2alphaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2alphaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2alphaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2betaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2betaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2betaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2betaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } /** * Extra GCF specific location information. */ diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index 54bd444454..858aa38f53 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -538,222 +538,6 @@ export namespace cloudfunctions_v2alpha { */ type?: string | null; } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2betaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2betaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2betaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2betaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2betaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2LocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2OperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2Stage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2Stage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2StateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2StateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } /** * Response for the `ListFunctions` method. */ diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index a5fe59da92..137078e2fb 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -430,114 +430,6 @@ export namespace cloudfunctions_v2beta { */ uploadUrl?: string | null; } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2alphaLocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaOperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2alphaStage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2alphaStage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2alphaStateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2alphaStateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } /** * Extra GCF specific location information. */ @@ -646,114 +538,6 @@ export namespace cloudfunctions_v2beta { */ type?: string | null; } - /** - * Extra GCF specific location information. - */ - export interface Schema$GoogleCloudFunctionsV2LocationMetadata { - /** - * The Cloud Function environments this location supports. - */ - environments?: string[] | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$GoogleCloudFunctionsV2OperationMetadata { - /** - * API version used to start the operation. - */ - apiVersion?: string | null; - /** - * The build name of the function for create and update operations. - */ - buildName?: string | null; - /** - * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - */ - cancelRequested?: boolean | null; - /** - * The time the operation was created. - */ - createTime?: string | null; - /** - * The time the operation finished running. - */ - endTime?: string | null; - /** - * The operation type. - */ - operationType?: string | null; - /** - * The original request that started the operation. - */ - requestResource?: {[key: string]: any} | null; - /** - * An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. - */ - sourceToken?: string | null; - /** - * Mechanism for reporting in-progress stages - */ - stages?: Schema$GoogleCloudFunctionsV2Stage[]; - /** - * Human-readable status of the operation, if any. - */ - statusDetail?: string | null; - /** - * Server-defined resource path for the target of the operation. - */ - target?: string | null; - /** - * Name of the verb executed by the operation. - */ - verb?: string | null; - } - /** - * Each Stage of the deployment process - */ - export interface Schema$GoogleCloudFunctionsV2Stage { - /** - * Message describing the Stage - */ - message?: string | null; - /** - * Name of the Stage. This will be unique for each Stage. - */ - name?: string | null; - /** - * Resource of the Stage - */ - resource?: string | null; - /** - * Link to the current Stage resource - */ - resourceUri?: string | null; - /** - * Current state of the Stage - */ - state?: string | null; - /** - * State messages from the current Stage. - */ - stateMessages?: Schema$GoogleCloudFunctionsV2StateMessage[]; - } - /** - * Informational messages about the state of the Cloud Function or Operation. - */ - export interface Schema$GoogleCloudFunctionsV2StateMessage { - /** - * The message. - */ - message?: string | null; - /** - * Severity of the state message. - */ - severity?: string | null; - /** - * One-word CamelCase type of the state message. - */ - type?: string | null; - } /** * Response for the `ListFunctions` method. */ diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 2c6f7bb68d..bc3b7a49fb 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -389,12 +389,12 @@ export namespace cloudidentity_v1 { */ chromeProfileId?: string | null; /** - * Timestamp in milliseconds since Epoch when the profile/gcm id was last synced. + * Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. */ lastProfileSyncTime?: string | null; } /** - * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange + * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). */ export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo { /** @@ -402,7 +402,7 @@ export namespace cloudidentity_v1 { */ browserManagementState?: string | null; /** - * Version of the request initiating browser. + * Version of the request initiating browser. E.g. `91.0.4442.4`. */ browserVersion?: string | null; /** @@ -825,7 +825,7 @@ export namespace cloudidentity_v1 { */ export interface Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes { /** - * Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. + * [Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. */ additionalSignals?: {[key: string]: any} | null; /** diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index d7a06108de..1f54ff04b8 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -230,11 +230,11 @@ export namespace cloudidentity_v1beta1 { deviceUser?: Schema$DeviceUser; } /** - * Contains information about browser profiles reported by the Endpoint Verification extension. + * Contains information about browser profiles reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). */ export interface Schema$BrowserAttributes { /** - * Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the Endpoint Verification extension. + * Represents the current state of the [Chrome browser attributes](https://cloud.google.com/access-context-manager/docs/browser-attributes) sent by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). */ chromeBrowserInfo?: Schema$BrowserInfo; /** @@ -242,12 +242,12 @@ export namespace cloudidentity_v1beta1 { */ chromeProfileId?: string | null; /** - * Timestamp in milliseconds since Epoch when the profile/gcm id was last synced. + * Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. */ lastProfileSyncTime?: string | null; } /** - * Browser-specific fields reported by the Endpoint Verification extension. LINT.IfChange + * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). */ export interface Schema$BrowserInfo { /** @@ -255,7 +255,7 @@ export namespace cloudidentity_v1beta1 { */ browserManagementState?: string | null; /** - * Version of the request initiating browser. + * Version of the request initiating browser. E.g. `91.0.4442.4`. */ browserVersion?: string | null; /** @@ -754,7 +754,7 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$EndpointVerificationSpecificAttributes { /** - * Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. Configurable attributes: file_config, registry_config, and plist_config. + * [Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. */ additionalSignals?: {[key: string]: any} | null; /** @@ -877,12 +877,12 @@ export namespace cloudidentity_v1beta1 { */ chromeProfileId?: string | null; /** - * Timestamp in milliseconds since Epoch when the profile/gcm id was last synced. + * Timestamp in milliseconds since the Unix epoch when the profile/gcm id was last synced. */ lastProfileSyncTime?: string | null; } /** - * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). LINT.IfChange + * Browser-specific fields reported by the [Endpoint Verification extension](https://chromewebstore.google.com/detail/endpoint-verification/callobklhcbilhphinckomhgkigmfocg?pli=1). */ export interface Schema$GoogleAppsCloudidentityDevicesV1BrowserInfo { /** @@ -890,7 +890,7 @@ export namespace cloudidentity_v1beta1 { */ browserManagementState?: string | null; /** - * Version of the request initiating browser. + * Version of the request initiating browser. E.g. `91.0.4442.4`. */ browserVersion?: string | null; /** @@ -1295,7 +1295,7 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$GoogleAppsCloudidentityDevicesV1EndpointVerificationSpecificAttributes { /** - * Additional signals reported by Endpoint Verification. It includes the following attributes: 1. Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. 2. [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. + * [Additional signals](https://cloud.google.com/endpoint-verification/docs/device-information) reported by Endpoint Verification. It includes the following attributes: * Non-configurable attributes: hotfixes, av_installed, av_enabled, windows_domain_name, is_os_native_firewall_enabled, and is_secure_boot_enabled. * [Configurable attributes](https://cloud.google.com/endpoint-verification/docs/collect-config-attributes): file, folder, and binary attributes; registry entries; and properties in a plist. */ additionalSignals?: {[key: string]: any} | null; /** @@ -1913,7 +1913,7 @@ export namespace cloudidentity_v1beta1 { type?: string | null; } /** - * POSIX Group definition to represent a group in a POSIX compliant system. + * POSIX Group definition to represent a group in a POSIX compliant system. Caution: POSIX groups are deprecated. As of September 26, 2024, you can no longer create new POSIX groups. For more information, see https://cloud.google.com/identity/docs/deprecations/posix-groups */ export interface Schema$PosixGroup { /** diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 51379a8a59..93a2e3bb19 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -3655,7 +3655,7 @@ export namespace cloudkms_v1 { */ filter?: string; /** - * Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most KeyHandles 100 will be returned. + * Optional. Optional limit on the number of KeyHandles to include in the response. The service may return fewer than this value. Further KeyHandles can subsequently be obtained by including the ListKeyHandlesResponse.next_page_token in a subsequent request. If unspecified, at most 100 KeyHandles will be returned. */ pageSize?: number; /** diff --git a/src/apis/cloudscheduler/v1.ts b/src/apis/cloudscheduler/v1.ts index 7cb82b884a..79841652e6 100644 --- a/src/apis/cloudscheduler/v1.ts +++ b/src/apis/cloudscheduler/v1.ts @@ -112,6 +112,7 @@ export namespace cloudscheduler_v1 { */ export class Cloudscheduler { context: APIRequestContext; + operations: Resource$Operations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace cloudscheduler_v1 { google, }; + this.operations = new Resource$Operations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -170,6 +172,10 @@ export namespace cloudscheduler_v1 { */ version?: string | null; } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ @@ -290,6 +296,19 @@ export namespace cloudscheduler_v1 { */ 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. */ @@ -341,6 +360,64 @@ export namespace cloudscheduler_v1 { */ serviceAccountEmail?: 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. 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`. + */ + cancelRequested?: boolean | 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. Human-readable status of the operation, if any. + */ + statusDetail?: 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; + } /** * Request message for PauseJob. */ @@ -438,6 +515,404 @@ export namespace cloudscheduler_v1 { message?: string | null; } + export class Resource$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$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.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$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudscheduler.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$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$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$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; diff --git a/src/apis/cloudscheduler/v1beta1.ts b/src/apis/cloudscheduler/v1beta1.ts index 3f8128119a..ee2e35239d 100644 --- a/src/apis/cloudscheduler/v1beta1.ts +++ b/src/apis/cloudscheduler/v1beta1.ts @@ -345,6 +345,39 @@ export namespace cloudscheduler_v1beta1 { */ serviceAccountEmail?: string | 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. 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`. + */ + cancelRequested?: boolean | 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. Human-readable status of the operation, if any. + */ + statusDetail?: 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; + } /** * Request message for PauseJob. */ diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index c5233698a5..b157882a33 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -200,6 +200,7 @@ export namespace compute_alpha { regionTargetTcpProxies: Resource$Regiontargettcpproxies; regionUrlMaps: Resource$Regionurlmaps; regionZones: Resource$Regionzones; + reservationBlocks: Resource$Reservationblocks; reservations: Resource$Reservations; resourcePolicies: Resource$Resourcepolicies; routers: Resource$Routers; @@ -371,6 +372,7 @@ export namespace compute_alpha { ); 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); @@ -860,6 +862,10 @@ export namespace compute_alpha { * [Output Only] Contains output only fields. */ export interface Schema$AllocationResourceStatus { + /** + * Indicates number of blocks for accelerator optimized family (applicable beyond A3 only). + */ + reservationBlockCount?: number | null; /** * Allocation Properties of this reservation. */ @@ -1852,6 +1858,10 @@ export namespace compute_alpha { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * List of custom metrics that are used for the WEIGHTED_ROUND_ROBIN locality_lb_policy. + */ + customMetrics?: Schema$BackendServiceCustomMetric[]; /** * Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). */ @@ -2151,6 +2161,19 @@ export namespace compute_alpha { */ trackingMode?: string | null; } + /** + * Custom Metrics are used for WEIGHTED_ROUND_ROBIN locality_lb_policy. + */ + export interface Schema$BackendServiceCustomMetric { + /** + * If true, the metric data is not used for load balancing. + */ + dryRun?: boolean | null; + /** + * Name of a custom utilization signal. The name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + */ + name?: string | null; + } /** * For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). */ @@ -2683,7 +2706,7 @@ export namespace compute_alpha { */ instanceProperties?: Schema$InstanceProperties; /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. */ locationPolicy?: Schema$LocationPolicy; /** @@ -7044,6 +7067,10 @@ export namespace compute_alpha { * Pagination behavior of the listManagedInstances API method for this managed instance group. */ listManagedInstancesResults?: string | null; + /** + * URL to the multi-MIG that this Managed Instance Group belongs to. + */ + multiMig?: string | null; /** * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ @@ -8311,6 +8338,13 @@ export namespace compute_alpha { */ resourcePolicies?: string[] | null; } + export interface Schema$InstancesReportHostAsFaultyRequest { + faultReasons?: Schema$InstancesReportHostAsFaultyRequestFaultReason[]; + } + export interface Schema$InstancesReportHostAsFaultyRequestFaultReason { + behavior?: string | null; + description?: string | null; + } export interface Schema$InstancesResumeRequest { /** * Array of disks associated with this instance that are protected with a customer-supplied encryption key. In order to resume the instance, the disk url and its corresponding key must be provided. If the disk is not protected with a customer-supplied encryption key it should not be specified. @@ -8814,7 +8848,7 @@ export namespace compute_alpha { */ applicationAwareInterconnect?: Schema$InterconnectApplicationAwareInterconnect; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. */ availableFeatures?: string[] | null; /** @@ -8910,7 +8944,7 @@ export namespace compute_alpha { */ remoteLocation?: string | null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. */ requestedFeatures?: string[] | null; /** @@ -10624,6 +10658,7 @@ export namespace compute_alpha { * [Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: - NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. - CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. - CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. - RECREATING The managed instance group is recreating this instance. - DELETING The managed instance group is permanently deleting this instance. - ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. - RESTARTING The managed instance group is restarting the instance. - REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. - VERIFYING The managed instance group has created the instance and it is in the process of being verified. */ currentAction?: string | null; + currentActionDetails?: Schema$ManagedInstanceCurrentActionDetails; /** * [Output only] The unique identifier for this resource. This field is empty when instance does not exist. */ @@ -10691,6 +10726,13 @@ export namespace compute_alpha { */ revision?: string | null; } + export interface Schema$ManagedInstanceCurrentActionDetails { + methodName?: string | null; + /** + * [Output Only] Details of the current action that the managed instance group has scheduled for the instance. Contains trigger for the current action, and methodName in case it was triggered by API call. Possible values for trigger: - API Any API call. - PROACTIVE_UPDATE Proactive updater scheduled an update on this managed instance. - AUTOSCALING Instance being deleted/created after a decision from the Autoscaler. - REDISTRIBUTION The regional managed instance group is moving instances between zones to restore balance. - STANDBY_REFILL The managed instance group is refilling the Standby Pool (stopped/suspended virtual machines) after scale up. - MAINTENANCE Manual maintenance. - FAILED_CREATION The managed instance group is handling failed instance creation. - INSTANCE_FAILURE The managed instance group is handling instance failure, according to the Instance Lifecycle Policy. - FAILED_HEALTH_CHECK The managed instance group is handling failed health check, according to the Instance Lifecycle Policy. - TERMINATION_TIMESTAMP Instance reached termination time, thus managed instance group stops/deletes it. + */ + trigger?: string | null; + } export interface Schema$ManagedInstanceInstanceFlexibilityOverride { /** * The machine type to be used for this instance. @@ -14988,6 +15030,10 @@ export namespace compute_alpha { * Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format. */ deleteAtTime?: 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. */ @@ -14996,6 +15042,10 @@ export namespace compute_alpha { * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string | null; + /** + * Instance termination action that will be invoked when the reservation is deleted. + */ + instanceTerminationAction?: string | null; /** * [Output Only] Type of the resource. Always compute#reservations for reservations. */ @@ -15103,6 +15153,91 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents a reservation block resource. + */ + export interface Schema$ReservationBlock { + /** + * [Output Only] Specifies the number of resources that are allocated in this block. It indicates the maximum number of VMs that a user can run on this particular 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] Indicates how many instances are in use on this block. + */ + inUseCount?: number | null; + /** + * [Output Only] Type of the resource. Always compute#reservationBlock for reservation blocks. + */ + kind?: string | null; + /** + * [Output Only] Obfuscated location where this reservation block physically resides in format /CCCC/GGGG. This matches the tripod specified in the VM topology information. Example: /USEAB1/0101/ is the location prefix in /USEAB1/0101/031/003 + */ + locationPrefix?: 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] 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$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. @@ -15814,6 +15949,10 @@ export namespace compute_alpha { } | null; } export interface Schema$RoutePolicy { + /** + * An optional description of route policy. + */ + description?: string | null; /** * A fingerprint for the Route Policy being applied to this Router, which is essentially a hash of the Route Policy used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update Route Policy. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a getRoutePolicy() request to retrieve a Route Policy. */ @@ -19509,7 +19648,7 @@ export namespace compute_alpha { */ id?: string | null; /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. */ internalIpv6Prefix?: string | null; /** @@ -26529,7 +26668,7 @@ export namespace compute_alpha { } /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -50474,6 +50613,94 @@ export namespace compute_alpha { } } + /** + * Mark the host as faulty and try to restart the instance on a new host. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params?: Params$Resource$Instances$Reporthostasfaulty, + options?: MethodOptions + ): GaxiosPromise; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty( + params: Params$Resource$Instances$Reporthostasfaulty, + callback: BodyResponseCallback + ): void; + reportHostAsFaulty(callback: BodyResponseCallback): void; + reportHostAsFaulty( + paramsOrCallback?: + | Params$Resource$Instances$Reporthostasfaulty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Reporthostasfaulty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Reporthostasfaulty; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Performs a reset on the instance. This is a hard reset. The VM does not do a graceful shutdown. For more information, see Resetting an instance. * @@ -53721,6 +53948,30 @@ export namespace compute_alpha { */ requestBody?: Schema$InstancesRemoveResourcePoliciesRequest; } + export interface Params$Resource$Instances$Reporthostasfaulty + extends StandardParameters { + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesReportHostAsFaultyRequest; + } export interface Params$Resource$Instances$Reset extends StandardParameters { /** * Name of the instance scoping this request. @@ -55731,6 +55982,94 @@ export namespace compute_alpha { } } + /** + * 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$Instantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * inserts a Zonal InstantSnapshotGroup resource * @@ -55913,6 +56252,189 @@ export namespace compute_alpha { 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$Instantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Instantsnapshotgroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$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}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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$Instantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Instantsnapshotgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$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}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Instantsnapshotgroups$Delete @@ -55949,6 +56471,25 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Instantsnapshotgroups$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instantsnapshotgroups$Insert extends StandardParameters { /** @@ -56004,6 +56545,46 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Instantsnapshotgroups$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ZoneSetPolicyRequest; + } + export interface Params$Resource$Instantsnapshotgroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Instantsnapshots { context: APIRequestContext; @@ -79127,7 +79708,7 @@ export namespace compute_alpha { } /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -84926,6 +85507,204 @@ export namespace compute_alpha { this.context = context; } + /** + * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regioninstancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns all of the details about the specified resize request. * @@ -85222,6 +86001,52 @@ export namespace compute_alpha { } } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique 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 resize request to cancel. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique 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 resize request to delete. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get extends StandardParameters { /** @@ -89779,6 +90604,94 @@ export namespace compute_alpha { } } + /** + * 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$Regioninstantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * creates a Regional InstantSnapshotGroup resource * @@ -89961,6 +90874,190 @@ export namespace compute_alpha { 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$Regioninstantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Regioninstantsnapshotgroups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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$Regioninstantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Regioninstantsnapshotgroups$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstantsnapshotgroups$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Regioninstantsnapshotgroups$Delete @@ -89997,6 +91094,25 @@ export namespace compute_alpha { */ region?: string; } + export interface Params$Resource$Regioninstantsnapshotgroups$Getiampolicy + extends StandardParameters { + /** + * Requested IAM Policy version. + */ + optionsRequestedPolicyVersion?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + } export interface Params$Resource$Regioninstantsnapshotgroups$Insert extends StandardParameters { /** @@ -90052,6 +91168,46 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Regioninstantsnapshotgroups$Setiampolicy + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Regioninstantsnapshotgroups$Testiampermissions + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } export class Resource$Regioninstantsnapshots { context: APIRequestContext; @@ -101920,6 +103076,262 @@ export namespace compute_alpha { 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/alpha/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/alpha/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 + ); + } + } + } + + 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. + */ + reservation?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the zone for this request. Zone name should conform to RFC1035. + */ + zone?: string; + } + export class Resource$Reservations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 8cd21634f5..ca6f9b3b15 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -174,6 +174,7 @@ export namespace compute_beta { regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionInstanceGroupManagerResizeRequests: Resource$Regioninstancegroupmanagerresizerequests; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; regionInstances: Resource$Regioninstances; @@ -310,6 +311,8 @@ export namespace compute_beta { this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( this.context ); + this.regionInstanceGroupManagerResizeRequests = + new Resource$Regioninstancegroupmanagerresizerequests(this.context); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers(this.context); this.regionInstanceGroups = new Resource$Regioninstancegroups( @@ -1537,6 +1540,10 @@ export namespace compute_beta { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * [Output Only] List of resources referencing that backend bucket. + */ + usedBy?: Schema$BackendBucketUsedBy[]; } /** * Message containing Cloud CDN configuration for a backend bucket. @@ -1659,6 +1666,12 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$BackendBucketUsedBy { + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + */ + reference?: string | null; + } /** * Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/beta/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/beta/regionBackendServices) For more information, see Backend Services. */ @@ -2397,7 +2410,7 @@ export namespace compute_beta { */ instanceProperties?: Schema$InstanceProperties; /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. */ locationPolicy?: Schema$LocationPolicy; /** @@ -6401,6 +6414,10 @@ export namespace compute_beta { * Pagination behavior of the listManagedInstances API method for this managed instance group. */ listManagedInstancesResults?: string | null; + /** + * URL to the multi-MIG that this Managed Instance Group belongs to. + */ + multiMig?: string | null; /** * The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. */ @@ -7946,7 +7963,7 @@ export namespace compute_beta { */ adminEnabled?: boolean | null; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. */ availableFeatures?: string[] | null; /** @@ -8042,7 +8059,7 @@ export namespace compute_beta { */ remoteLocation?: string | null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. */ requestedFeatures?: string[] | null; /** @@ -10216,6 +10233,10 @@ export namespace compute_beta { * [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. */ consumerPscAddress?: string | null; + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + */ + producerPort?: number | null; /** * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. */ @@ -12671,6 +12692,41 @@ export namespace compute_beta { */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } + export interface Schema$RegionInstanceGroupManagerResizeRequestsListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Resize Request resources. + */ + items?: Schema$InstanceGroupManagerResizeRequest[]; + /** + * [Output Only] Type of the resource. Always compute#regionInstanceGroupManagerResizeRequestList for a list of Resize Requests. + */ + 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$RegionInstanceGroupManagersAbandonInstancesRequest { /** * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -13002,6 +13058,10 @@ export namespace compute_beta { * The full or partial URL to the BackendService resource being mirrored to. The backend service configured for a mirroring policy must reference backends that are of the same type as the original backend service matched in the URL map. Serverless NEG backends are not currently supported as a mirrored backend service. */ backendService?: string | null; + /** + * The percentage of requests to be mirrored to `backend_service`. + */ + mirrorPercent?: number | null; } /** * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. @@ -17041,7 +17101,7 @@ export namespace compute_beta { */ id?: string | null; /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. */ internalIpv6Prefix?: string | null; /** @@ -23782,7 +23842,7 @@ export namespace compute_beta { } /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -73786,7 +73846,7 @@ export namespace compute_beta { } /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -79007,6 +79067,631 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regioninstancegroupmanagerresizerequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Regioninstancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns all of the details about the specified resize request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a list of Resize Requests that are contained in the managed instance group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Cancel + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique 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 resize request to cancel. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Delete + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique 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 resize request to delete. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$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 name of the managed instance group. The name should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export class Resource$Regioninstancegroupmanagers { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index a118730cd5..4e83e54104 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1482,6 +1482,10 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * [Output Only] List of resources referencing that backend bucket. + */ + usedBy?: Schema$BackendBucketUsedBy[]; } /** * Message containing Cloud CDN configuration for a backend bucket. @@ -1604,6 +1608,12 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$BackendBucketUsedBy { + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + */ + reference?: string | null; + } /** * Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices) For more information, see Backend Services. */ @@ -2264,7 +2274,7 @@ export namespace compute_v1 { */ instanceProperties?: Schema$InstanceProperties; /** - * Policy for chosing target zone. For more information, see Create VMs in bulk . + * Policy for choosing target zone. For more information, see Create VMs in bulk. */ locationPolicy?: Schema$LocationPolicy; /** @@ -7478,7 +7488,7 @@ export namespace compute_v1 { */ adminEnabled?: boolean | null; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - IF_MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. */ availableFeatures?: string[] | null; /** @@ -7574,7 +7584,7 @@ export namespace compute_v1 { */ remoteLocation?: string | null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - IF_MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. */ requestedFeatures?: string[] | null; /** @@ -9473,6 +9483,10 @@ export namespace compute_v1 { * Metadata defined as annotations on the network endpoint. */ annotations?: {[key: string]: string} | null; + /** + * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + */ + clientDestinationPort?: number | null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ @@ -9687,6 +9701,10 @@ export namespace compute_v1 { * [Output Only] Address allocated from given subnetwork for PSC. This IP address acts as a VIP for a PSC NEG, allowing it to act as an endpoint in L7 PSC-XLB. */ consumerPscAddress?: string | null; + /** + * The psc producer port is used to connect PSC NEG with specific port on the PSC Producer side; should only be used for the PRIVATE_SERVICE_CONNECT NEG type + */ + producerPort?: number | null; /** * [Output Only] The PSC connection id of the PSC Network Endpoint Group Consumer. */ @@ -15972,7 +15990,7 @@ export namespace compute_v1 { */ id?: string | null; /** - * [Output Only] The internal IPv6 address range that is assigned to this subnetwork. + * The internal IPv6 address range that is owned by this subnetwork. */ internalIpv6Prefix?: string | null; /** @@ -22452,7 +22470,7 @@ export namespace compute_v1 { } /** - * Retrieves an aggregated list of all usable backend services in the specified project. + * Retrieves a list of all usable backend services in the specified project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -67049,7 +67067,7 @@ export namespace compute_v1 { } /** - * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * Retrieves a list of all usable backend services in the specified project in the given region. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index e0ae1fcc0c..9d3a53001f 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -170,6 +170,10 @@ export namespace connectors_v1 { * Oauth2AuthCodeFlow. */ oauth2AuthCodeFlow?: Schema$Oauth2AuthCodeFlow; + /** + * Oauth2AuthCodeFlowGoogleManaged. + */ + oauth2AuthCodeFlowGoogleManaged?: Schema$Oauth2AuthCodeFlowGoogleManaged; /** * Oauth2ClientCredentials. */ @@ -216,6 +220,56 @@ export namespace connectors_v1 { */ isDefault?: boolean | null; } + /** + * AuthField defines a field in an authentication type. + */ + export interface Schema$AuthField { + /** + * Data type of the field. + */ + dataType?: string | null; + /** + * Description of the field. + */ + description?: string | null; + /** + * Key of the field. + */ + key?: string | null; + } + /** + * AuthObject defines a JSON schema of an authentication type. + */ + export interface Schema$AuthObject { + /** + * Whether the object has additional properties. + */ + additionalProperties?: boolean | null; + /** + * Auth key of the object. + */ + authKey?: string | null; + /** + * Auth type of the object. + */ + authType?: string | null; + /** + * Description of the object. + */ + description?: string | null; + /** + * Whether the object is the default one. + */ + isDefault?: boolean | null; + /** + * Properties of the object. + */ + properties?: {[key: string]: Schema$AuthProperty} | null; + /** + * Type of the object. + */ + type?: string | null; + } /** * This configuration captures the details required to render an authorization link for the OAuth Authorization Code Flow. */ @@ -224,6 +278,10 @@ export namespace connectors_v1 { * The client ID assigned to the Google Cloud Connectors OAuth app for the connector data source. */ clientId?: string | null; + /** + * Optional. The client secret assigned to the Google Cloud Connectors OAuth app for the connector data source. + */ + clientSecret?: Schema$Secret; /** * Whether to enable PKCE for the auth code flow. */ @@ -241,6 +299,48 @@ export namespace connectors_v1 { */ uri?: string | null; } + /** + * AuthProperty defines a property of an authentication type. + */ + export interface Schema$AuthProperty { + /** + * Description of the property. + */ + description?: string | null; + /** + * Type of the property. + */ + type?: string | null; + } + /** + * AuthSchema defines the schema of an authentication type. + */ + export interface Schema$AuthSchema { + /** + * List of AuthFields. + */ + authFields?: Schema$AuthField[]; + /** + * Auth key of the schema. + */ + authKey?: string | null; + /** + * Auth type of the schema. + */ + authType?: string | null; + /** + * Description of the schema. + */ + description?: string | null; + /** + * Display name of the schema. + */ + displayName?: string | null; + /** + * Whether the auth schema is the default one. + */ + isDefault?: boolean | null; + } /** * Billing config for the connection. */ @@ -377,6 +477,10 @@ export namespace connectors_v1 { * Optional. Configuration for establishing the connection's authentication with an external system. */ authConfig?: Schema$AuthConfig; + /** + * Optional. Auth override enabled for the connection. If Auth Override is enabled, Connection allows the backend service auth to be overridden in the entities/actions API. + */ + authOverrideEnabled?: boolean | null; /** * Output only. Billing config for the connection. */ @@ -609,6 +713,10 @@ export namespace connectors_v1 { * This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version */ export interface Schema$ConnectorInfraConfig { + /** + * Indicates that the Cloud Run CPU should always be allocated. + */ + alwaysAllocateCpu?: boolean | null; /** * The window used for ratelimiting runtime requests to connections. */ @@ -633,6 +741,14 @@ export namespace connectors_v1 { * Indicate whether connector is being migrated to cloud run deployment model. */ migrateDeploymentModel?: boolean | null; + /** + * Indicate whether connector is being migrated to TLS. + */ + migrateTls?: boolean | null; + /** + * Indicate whether cloud spanner is required for connector job. + */ + provisionCloudSpanner?: boolean | null; /** * Max QPS supported by the connector version before throttling of requests. */ @@ -812,6 +928,10 @@ export namespace connectors_v1 { * Output only. The name of shared connector deployment. */ sharedDeployment?: string | null; + /** + * Output only. Status of the TLS migration. + */ + tlsMigrationState?: string | null; } /** * CustomConnector represents the custom connector defined by the customer as part of byoc. @@ -1477,6 +1597,19 @@ export namespace connectors_v1 { */ extractionRule?: Schema$ExtractionRule[]; } + /** + * Response message for Connectors.GetAuthSchema. + */ + export interface Schema$FetchAuthSchemaResponse { + /** + * List of AuthSchemas. + */ + authSchemas?: Schema$AuthSchema[]; + /** + * JSON schema of the AuthSchemas. This is only populated if the view is JSON_SCHEMA. The schema is in draft-07 format. + */ + jsonSchema?: Schema$JsonAuthSchema; + } /** * Metadata of an entity field. */ @@ -1686,6 +1819,19 @@ export namespace connectors_v1 { */ type?: string | null; } + /** + * JsonAuthSchema defines the JSON schema of all authentication types. + */ + export interface Schema$JsonAuthSchema { + /** + * JSON schema of the AuthSchemas. + */ + $schema?: string | null; + /** + * List of AuthObjects. + */ + oneOf?: Schema$AuthObject[]; + } /** * JsonSchema representation of schema metadata */ @@ -2304,6 +2450,23 @@ export namespace connectors_v1 { */ scopes?: string[] | null; } + /** + * Parameters to support Oauth 2.0 Auth Code Grant Authentication using Google Provided OAuth Client. See https://tools.ietf.org/html/rfc6749#section-1.3.1 for more details. + */ + export interface Schema$Oauth2AuthCodeFlowGoogleManaged { + /** + * Optional. Authorization code to be exchanged for access and refresh tokens. + */ + authCode?: string | null; + /** + * Optional. Redirect URI to be provided during the auth code exchange. + */ + redirectUri?: string | null; + /** + * Required. Scopes the connection will request when the user performs the auth code flow. + */ + scopes?: string[] | null; + } /** * Parameters to support Oauth 2.0 Client Credentials Grant Authentication. See https://tools.ietf.org/html/rfc6749#section-1.3.4 for more details. */ @@ -9929,6 +10092,102 @@ export namespace connectors_v1 { ); } + /** + * fetch and return the list of auth config variables required to override the connection backend auth. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchAuthSchema( + params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema, + options: StreamMethodOptions + ): GaxiosPromise; + fetchAuthSchema( + params?: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema, + options?: MethodOptions + ): GaxiosPromise; + fetchAuthSchema( + params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAuthSchema( + params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAuthSchema( + params: Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema, + callback: BodyResponseCallback + ): void; + fetchAuthSchema( + callback: BodyResponseCallback + ): void; + fetchAuthSchema( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://connectors.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchAuthSchema').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 details of a single connector version. * @@ -10114,6 +10373,17 @@ export namespace connectors_v1 { } } + export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$Fetchauthschema + extends StandardParameters { + /** + * Required. Parent resource of the Connector Version, of the form: `projects/x/locations/x/providers/x/connectors/x/versions/x` + */ + name?: string; + /** + * Optional. View of the AuthSchema. The default value is BASIC. + */ + view?: string; + } export interface Params$Resource$Projects$Locations$Providers$Connectors$Versions$Get extends StandardParameters { /** diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index 3f8996bf84..eb8281563f 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -253,7 +253,7 @@ export namespace contactcenteraiplatform_v1alpha1 { quotas?: Schema$Quota[]; } /** - * Instances in this Channel will receive updates after all instances in `Critical` were updated + 2 days. They also will only be updated outside of their peak hours. + * Instances in this Channel will receive updates after all instances in `Normal` were updated. They also will only be updated outside of their peak hours. */ export interface Schema$Critical { /** @@ -470,6 +470,10 @@ export namespace contactcenteraiplatform_v1alpha1 { * The list of project ids that are allowed to send traffic to the service attachment. This field should be filled only for the ingress components. */ allowedConsumerProjectIds?: string[] | null; + /** + * Output only. The CCAIP tenant project ids. + */ + producerProjectIds?: string[] | null; } /** * Quota details. diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index b965cbb507..57614413ed 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -542,6 +542,10 @@ export namespace contactcenterinsights_v1 { * Immutable. The conversation medium, if unspecified will default to PHONE_CALL. */ medium?: string | null; + /** + * Input only. JSON Metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insights' supported formats. + */ + metadataJson?: string | null; /** * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} */ @@ -2270,6 +2274,10 @@ export namespace contactcenterinsights_v1 { * Immutable. The conversation medium, if unspecified will default to PHONE_CALL. */ medium?: string | null; + /** + * Input only. JSON Metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insights' supported formats. + */ + metadataJson?: string | null; /** * Immutable. The resource name of the conversation. Format: projects/{project\}/locations/{location\}/conversations/{conversation\} */ @@ -4508,7 +4516,7 @@ export namespace contactcenterinsights_v1 { } /** - * Creates a conversation. Does not support audio transcription or DLP redaction. Use `conversations.upload` instead. + * 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`. @@ -5271,7 +5279,7 @@ export namespace contactcenterinsights_v1 { */ orderBy?: string; /** - * The maximum number of conversations to return in the response. A valid page size ranges from 0 to 1,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. + * 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; /** diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 791cf02f9d..5536d27c2a 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -170,6 +170,10 @@ export namespace container_v1 { * The maximum number of pods per node which use this pod network. */ maxPodsPerNode?: Schema$MaxPodsConstraint; + /** + * The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range. + */ + networkAttachment?: string | null; /** * The name of the secondary range on the subnet which provides IP address for this pod range. */ @@ -579,6 +583,10 @@ export namespace container_v1 { * The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. */ clusterIpv4Cidr?: string | null; + /** + * Enable/Disable Compliance Posture features for the cluster. + */ + compliancePostureConfig?: Schema$CompliancePostureConfig; /** * Which conditions caused the current cluster state. */ @@ -831,6 +839,10 @@ export namespace container_v1 { * Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string | null; + /** + * The Custom keys configuration for the cluster. + */ + userManagedKeysConfig?: Schema$UserManagedKeysConfig; /** * Cluster-level Vertical Pod Autoscaling configuration. */ @@ -906,6 +918,10 @@ export namespace container_v1 { * Cluster-level autoscaling configuration. */ desiredClusterAutoscaling?: Schema$ClusterAutoscaling; + /** + * Enable/Disable Compliance Posture features for the cluster. + */ + desiredCompliancePostureConfig?: Schema$CompliancePostureConfig; /** * The desired containerd config for the cluster. */ @@ -1118,6 +1134,10 @@ export namespace container_v1 { * The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. */ removedAdditionalPodRangesConfig?: Schema$AdditionalPodRangesConfig; + /** + * The Custom keys configuration for the cluster. + */ + userManagedKeysConfig?: Schema$UserManagedKeysConfig; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. @@ -1144,6 +1164,28 @@ export namespace container_v1 { * CompleteNodePoolUpgradeRequest sets the name of target node pool to complete upgrade. */ export interface Schema$CompleteNodePoolUpgradeRequest {} + /** + * CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. + */ + export interface Schema$CompliancePostureConfig { + /** + * List of enabled compliance standards. + */ + complianceStandards?: Schema$ComplianceStandard[]; + /** + * Defines the enablement mode for Compliance Posture. + */ + mode?: string | null; + } + /** + * Defines the details of a compliance standard. + */ + export interface Schema$ComplianceStandard { + /** + * Name of the compliance standard. + */ + standard?: string | null; + } /** * ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. */ @@ -1428,7 +1470,7 @@ export namespace container_v1 { */ export interface Schema$GetJSONWebKeysResponse { /** - * OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header. + * For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. */ cacheHeader?: Schema$HttpCacheControlResponseHeader; /** @@ -1441,7 +1483,7 @@ export namespace container_v1 { */ export interface Schema$GetOpenIDConfigResponse { /** - * OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header. + * For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. */ cacheHeader?: Schema$HttpCacheControlResponseHeader; /** @@ -2146,6 +2188,10 @@ export namespace container_v1 { * Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' */ diskType?: string | null; + /** + * Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. + */ + effectiveCgroupMode?: string | null; /** * Optional. Reserved for future use. */ @@ -3898,6 +3944,43 @@ export namespace container_v1 { */ status?: string | null; } + /** + * UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. + */ + export interface Schema$UserManagedKeysConfig { + /** + * The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + */ + aggregationCa?: string | null; + /** + * The Certificate Authority Service caPool to use for the cluster CA in this cluster. + */ + clusterCa?: string | null; + /** + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + */ + controlPlaneDiskEncryptionKey?: string | null; + /** + * Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + */ + etcdApiCa?: string | null; + /** + * Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + */ + etcdPeerCa?: string | null; + /** + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + */ + gkeopsEtcdBackupEncryptionKey?: string | null; + /** + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{cryptoKey\}/cryptoKeyVersions/{cryptoKeyVersion\}` + */ + serviceAccountSigningKeys?: string[] | null; + /** + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{cryptoKey\}/cryptoKeyVersions/{cryptoKeyVersion\}` + */ + serviceAccountVerificationKeys?: string[] | null; + } /** * VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 30d52f736f..923ed6a11b 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -174,6 +174,10 @@ export namespace container_v1beta1 { * The maximum number of pods per node which use this pod network. */ maxPodsPerNode?: Schema$MaxPodsConstraint; + /** + * The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range. + */ + networkAttachment?: string | null; /** * The name of the secondary range on the subnet which provides IP address for this pod range. */ @@ -913,6 +917,10 @@ export namespace container_v1beta1 { * Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string | null; + /** + * The Custom keys configuration for the cluster. + */ + userManagedKeysConfig?: Schema$UserManagedKeysConfig; /** * Cluster-level Vertical Pod Autoscaling configuration. */ @@ -1009,6 +1017,10 @@ export namespace container_v1beta1 { * The desired telemetry integration for the cluster. */ desiredClusterTelemetry?: Schema$ClusterTelemetry; + /** + * Enable/Disable Compliance Posture features for the cluster. + */ + desiredCompliancePostureConfig?: Schema$CompliancePostureConfig; /** * The desired containerd config for the cluster. */ @@ -1253,6 +1265,10 @@ export namespace container_v1beta1 { * The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. */ removedAdditionalPodRangesConfig?: Schema$AdditionalPodRangesConfig; + /** + * The Custom keys configuration for the cluster. + */ + userManagedKeysConfig?: Schema$UserManagedKeysConfig; } /** * CompleteIPRotationRequest moves the cluster master back into single-IP mode. @@ -1611,7 +1627,7 @@ export namespace container_v1beta1 { */ export interface Schema$GetJSONWebKeysResponse { /** - * OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header. + * For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. */ cacheHeader?: Schema$HttpCacheControlResponseHeader; /** @@ -1624,7 +1640,7 @@ export namespace container_v1beta1 { */ export interface Schema$GetOpenIDConfigResponse { /** - * OnePlatform automatically extracts this field and uses it to set the HTTP Cache-Control header. + * For HTTP requests, this field is automatically extracted into the Cache-Control HTTP header. */ cacheHeader?: Schema$HttpCacheControlResponseHeader; /** @@ -2406,6 +2422,10 @@ export namespace container_v1beta1 { * Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' */ diskType?: string | null; + /** + * Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version. + */ + effectiveCgroupMode?: string | null; /** * Optional. Reserved for future use. */ @@ -4251,6 +4271,43 @@ export namespace container_v1beta1 { */ status?: string | null; } + /** + * UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. + */ + export interface Schema$UserManagedKeysConfig { + /** + * The Certificate Authority Service caPool to use for the aggregation CA in this cluster. + */ + aggregationCa?: string | null; + /** + * The Certificate Authority Service caPool to use for the cluster CA in this cluster. + */ + clusterCa?: string | null; + /** + * The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. + */ + controlPlaneDiskEncryptionKey?: string | null; + /** + * Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. + */ + etcdApiCa?: string | null; + /** + * Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. + */ + etcdPeerCa?: string | null; + /** + * Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. + */ + gkeopsEtcdBackupEncryptionKey?: string | null; + /** + * The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{cryptoKey\}/cryptoKeyVersions/{cryptoKeyVersion\}` + */ + serviceAccountSigningKeys?: string[] | null; + /** + * The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: `projects/{project\}/locations/{location\}/keyRings/{keyring\}/cryptoKeys/{cryptoKey\}/cryptoKeyVersions/{cryptoKeyVersion\}` + */ + serviceAccountVerificationKeys?: string[] | null; + } /** * VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. */ diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index be173548d1..cd41ff2988 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -3754,6 +3754,95 @@ export namespace containeranalysis_v1beta1 { } } + /** + * Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Notes$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Notes$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+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 notes for the specified project. * @@ -3931,6 +4020,192 @@ export namespace containeranalysis_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Notes$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Notes$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Notes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Notes$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Notes$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notes$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Notes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notes$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.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$Notes$Batchcreate @@ -3975,6 +4250,18 @@ export namespace containeranalysis_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Notes$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$Notes$List extends StandardParameters { /** @@ -4010,6 +4297,30 @@ export namespace containeranalysis_v1beta1 { */ requestBody?: Schema$Note; } + export interface Params$Resource$Projects$Locations$Notes$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$Notes$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$Notes$Occurrences { context: APIRequestContext; @@ -4426,46 +4737,133 @@ export namespace containeranalysis_v1beta1 { params: Params$Resource$Projects$Locations$Occurrences$Get, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Occurrences$Get, + get( + params?: Params$Resource$Projects$Locations$Occurrences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a note or an occurrence resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Occurrences$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Occurrences$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Occurrences$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Occurrences$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Occurrences$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Occurrences$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Occurrences$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$Occurrences$Get; + {}) as Params$Resource$Projects$Locations$Occurrences$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Occurrences$Get; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Getiampolicy; options = {}; } @@ -4479,24 +4877,27 @@ export namespace containeranalysis_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); } } @@ -4866,6 +5267,193 @@ export namespace containeranalysis_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Sets the access control policy on the specified note or occurrence. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or an occurrence, respectively. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Occurrences$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Occurrences$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Occurrences$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Occurrences$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Occurrences$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Occurrences$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Occurrences$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Occurrences$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.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$Occurrences$Batchcreate @@ -4906,6 +5494,18 @@ export namespace containeranalysis_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Occurrences$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$Occurrences$Getnotes extends StandardParameters { /** @@ -4959,6 +5559,30 @@ export namespace containeranalysis_v1beta1 { */ requestBody?: Schema$Occurrence; } + export interface Params$Resource$Projects$Locations$Occurrences$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$Occurrences$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$Resources { context: APIRequestContext; diff --git a/src/apis/css/v1.ts b/src/apis/css/v1.ts index fd3e0159e9..8877da5de6 100644 --- a/src/apis/css/v1.ts +++ b/src/apis/css/v1.ts @@ -278,6 +278,10 @@ export namespace css_v1 { * Condition of the headline offer. */ headlineOfferCondition?: string | null; + /** + * Number and amount of installments to pay for an item. + */ + headlineOfferInstallment?: Schema$HeadlineOfferInstallment; /** * Link to the headline offer. */ @@ -294,6 +298,10 @@ export namespace css_v1 { * Headline Price of the aggregate offer. */ headlineOfferShippingPrice?: Schema$Price; + /** + * Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract. + */ + headlineOfferSubscriptionCost?: Schema$HeadlineOfferSubscriptionCost; /** * High Price of the aggregate offer. */ @@ -541,6 +549,40 @@ export namespace css_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 {} + /** + * A message that represents installment. + */ + export interface Schema$HeadlineOfferInstallment { + /** + * The amount the buyer has to pay per month. + */ + amount?: Schema$Price; + /** + * The up-front down payment amount the buyer has to pay. + */ + downpayment?: Schema$Price; + /** + * The number of installments the buyer has to pay. + */ + months?: string | null; + } + /** + * The SubscriptionCost of the product. + */ + export interface Schema$HeadlineOfferSubscriptionCost { + /** + * The amount the buyer has to pay per subscription period. + */ + amount?: Schema$Price; + /** + * The type of subscription period. Supported values are: * "`month`" * "`year`" + */ + period?: string | null; + /** + * The number of subscription periods the buyer has to pay. + */ + periodLength?: string | null; + } /** * The ItemLevelIssue of the product status. */ diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index e39158a665..4318d4fbfc 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -241,6 +241,15 @@ export namespace datamigration_v1 { */ logType?: string | null; } + /** + * AuthorizedNetwork contains metadata for an authorized network. + */ + export interface Schema$AuthorizedNetwork { + /** + * Optional. CIDR range for one authorzied network of the instance. + */ + cidrRange?: string | null; + } /** * Execution log of a background job. */ @@ -290,6 +299,19 @@ export namespace datamigration_v1 { */ startTime?: string | null; } + /** + * Configuration to use Binary Log Parser CDC technique. + */ + export interface Schema$BinaryLogParser { + /** + * Use Oracle directories. + */ + logFileDirectories?: Schema$LogFileDirectories; + /** + * Use Oracle ASM. + */ + oracleAsmLogFileAccess?: Schema$OracleAsmLogFileAccess; + } /** * Associates `members`, or principals, with a `role`. */ @@ -365,9 +387,13 @@ export namespace datamigration_v1 { */ databaseFlags?: {[key: string]: string} | null; /** - * The database engine type and version. + * The database engine type and version. Deprecated. Use database_version_name instead. */ databaseVersion?: string | null; + /** + * Optional. The database engine type and version name. + */ + databaseVersionName?: string | null; /** * Optional. Data cache is an optional feature available for Cloud SQL for MySQL Enterprise Plus edition only. For more information on data cache, see [Data cache overview](https://cloud.google.com/sql/help/mysql-data-cache) in Cloud SQL documentation. */ @@ -1242,6 +1268,23 @@ export namespace datamigration_v1 { */ unique?: boolean | null; } + /** + * Metadata related to instance level network configuration. + */ + export interface Schema$InstanceNetworkConfig { + /** + * Optional. A list of external network authorized to access this instance. + */ + authorizedExternalNetworks?: Schema$AuthorizedNetwork[]; + /** + * Optional. Enabling an outbound public IP address to support a database server sending requests out into the internet. + */ + enableOutboundPublicIp?: boolean | null; + /** + * Optional. Enabling public ip for the instance. + */ + enablePublicIp?: boolean | null; + } /** * Filter based on relation between source value and compare value of type integer in ConditionalColumnSetValue */ @@ -1387,6 +1430,23 @@ export namespace datamigration_v1 { */ name?: string | null; } + /** + * Configuration to specify the Oracle directories to access the log files. + */ + export interface Schema$LogFileDirectories { + /** + * Required. Oracle directory for archived logs. + */ + archivedLogDirectory?: string | null; + /** + * Required. Oracle directory for online logs. + */ + onlineLogDirectory?: string | null; + } + /** + * Configuration to use LogMiner CDC method. + */ + export interface Schema$LogMiner {} /** * MachineConfig describes the configuration of a machine. */ @@ -1579,6 +1639,10 @@ export namespace datamigration_v1 { * The name (URI) of this migration job resource, in the form of: projects/{project\}/locations/{location\}/migrationJobs/{migrationJob\}. */ name?: string | null; + /** + * Configuration for heterogeneous **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. + */ + oracleToPostgresConfig?: Schema$OracleToPostgresConfig; /** * Optional. Data dump parallelism settings used by the migration. */ @@ -1786,6 +1850,10 @@ export namespace datamigration_v1 { */ username?: string | null; } + /** + * Configuration to use Oracle ASM to access the log files. + */ + export interface Schema$OracleAsmLogFileAccess {} /** * Specifies connection parameters required specifically for Oracle databases. */ @@ -1835,6 +1903,48 @@ export namespace datamigration_v1 { */ username?: string | null; } + /** + * Configuration for Oracle as a source in a migration. + */ + export interface Schema$OracleSourceConfig { + /** + * Use Binary Log Parser. + */ + binaryLogParser?: Schema$BinaryLogParser; + /** + * Optional. The schema change number (SCN) to start CDC data migration from. + */ + cdcStartPosition?: string | null; + /** + * Use LogMiner. + */ + logMiner?: Schema$LogMiner; + /** + * 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 **Oracle to Cloud SQL for PostgreSQL** and **Oracle to AlloyDB for PostgreSQL** migrations. + */ + export interface Schema$OracleToPostgresConfig { + /** + * Optional. Configuration for Oracle source. + */ + oracleSourceConfig?: Schema$OracleSourceConfig; + /** + * Optional. Configuration for Postgres destination. + */ + postgresDestinationConfig?: Schema$PostgresDestinationConfig; + } /** * Package's parent is a schema. */ @@ -1903,6 +2013,19 @@ export namespace datamigration_v1 { */ offset?: number | null; } + /** + * Configuration for Postgres as a destination in a migration. + */ + export interface Schema$PostgresDestinationConfig { + /** + * Optional. Maximum number of connections Database Migration Service will open to the destination for data migration. + */ + maxConcurrentConnections?: number | null; + /** + * Optional. Timeout for data migration transactions. + */ + transactionTimeout?: string | null; + } /** * Specifies connection parameters required specifically for PostgreSQL databases. */ @@ -1964,6 +2087,10 @@ export namespace datamigration_v1 { * Required. The ID of the AlloyDB primary instance. The ID must satisfy the regex expression "[a-z0-9-]+". */ id?: string | null; + /** + * Optional. Metadata related to instance level network configuration. + */ + instanceNetworkConfig?: Schema$InstanceNetworkConfig; /** * Labels for the AlloyDB primary instance created by DMS. An object containing a list of 'key', 'value' pairs. */ @@ -1972,6 +2099,10 @@ export namespace datamigration_v1 { * Configuration for the machines that host the underlying database engine. */ machineConfig?: Schema$MachineConfig; + /** + * Output only. All outbound public IP addresses configured for the instance. + */ + outboundPublicIpAddresses?: string[] | null; /** * Output only. The private IP address for the Instance. This is the connection endpoint for an end-user application. */ diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index 2fcd6f2823..cbeea6514c 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -126,129 +126,6 @@ export namespace dataplex_v1 { } } - /** - * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. - */ - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosAssetLocation { - /** - * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. - */ - ccfeRmsPath?: string | null; - /** - * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. - */ - expected?: Schema$CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations; - /** - * Defines extra parameters required for specific asset types. - */ - extraParameters?: Schema$CloudReliabilityZicyWs3DataplaneProtosExtraParameter[]; - /** - * Contains all kinds of physical location definitions for this asset. - */ - locationData?: Schema$CloudReliabilityZicyWs3DataplaneProtosLocationData[]; - /** - * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. - */ - parentAsset?: Schema$CloudReliabilityZicyWs3DataplaneProtosCloudAsset[]; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectations { - /** - * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. - */ - requirementOverride?: Schema$CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride; - ziOrgPolicy?: string | null; - ziRegionPolicy?: string | null; - ziRegionState?: string | null; - /** - * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. - */ - zoneIsolation?: string | null; - /** - * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. - */ - zoneSeparation?: string | null; - zsOrgPolicy?: string | null; - zsRegionState?: string | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosAssetLocationIsolationExpectationsRequirementOverride { - ziOverride?: string | null; - zsOverride?: string | null; - } - /** - * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains - */ - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation { - policyId?: string[] | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosCloudAsset { - assetName?: string | null; - assetType?: string | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition { - childAsset?: Schema$CloudReliabilityZicyWs3DataplaneProtosCloudAsset[]; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment { - location?: Schema$CloudReliabilityZicyWs3DataplaneProtosLocationAssignment[]; - } - /** - * Defines parameters that should only be used for specific asset types. - */ - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosExtraParameter { - /** - * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. - */ - regionalMigDistributionPolicy?: Schema$CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosLocationAssignment { - location?: string | null; - locationType?: string | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosLocationData { - blobstoreLocation?: Schema$CloudReliabilityZicyWs3DataplaneProtosBlobstoreLocation; - childAssetLocation?: Schema$CloudReliabilityZicyWs3DataplaneProtosCloudAssetComposition; - directLocation?: Schema$CloudReliabilityZicyWs3DataplaneProtosDirectLocationAssignment; - gcpProjectProxy?: Schema$CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy; - placerLocation?: Schema$CloudReliabilityZicyWs3DataplaneProtosPlacerLocation; - spannerLocation?: Schema$CloudReliabilityZicyWs3DataplaneProtosSpannerLocation; - } - /** - * Message describing that the location of the customer resource is tied to placer allocations - */ - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosPlacerLocation { - /** - * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") - */ - placerConfig?: string | null; - } - /** - * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances - */ - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosRegionalMigDistributionPolicy { - /** - * The shape in which the group converges around distribution of resources. Instance of proto2 enum - */ - targetShape?: number | null; - /** - * Cloud zones used by regional MIG to create instances. - */ - zones?: Schema$CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration[]; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosSpannerLocation { - /** - * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata - */ - backupName?: string[] | null; - /** - * Set of databases used by the resource in format /span// - */ - dbName?: string[] | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosTenantProjectProxy { - projectNumbers?: string[] | null; - } - export interface Schema$CloudReliabilityZicyWs3DataplaneProtosZoneConfiguration { - zone?: 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); \} */ @@ -476,6 +353,10 @@ export namespace dataplex_v1 { * Output only. The relative resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. */ name?: string | null; + /** + * Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. + */ + transferStatus?: string | null; /** * Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different. */ @@ -2112,6 +1993,10 @@ export namespace dataplex_v1 { * The data location associated with the event. */ dataLocation?: string | null; + /** + * The id of the associated datascan for standalone discovery. + */ + datascanId?: string | null; /** * Details about the entity associated with the event. */ @@ -2128,6 +2013,10 @@ export namespace dataplex_v1 { * Details about the partition associated with the event. */ partition?: Schema$GoogleCloudDataplexV1DiscoveryEventPartitionDetails; + /** + * Details about the BigQuery table publishing associated with the event. + */ + table?: Schema$GoogleCloudDataplexV1DiscoveryEventTableDetails; /** * The type of the event being logged. */ @@ -2189,6 +2078,19 @@ export namespace dataplex_v1 { */ type?: string | null; } + /** + * Details about the published table. + */ + export interface Schema$GoogleCloudDataplexV1DiscoveryEventTableDetails { + /** + * The fully-qualified resource name of the table resource. + */ + table?: string | null; + /** + * The type of the table resource. + */ + type?: string | null; + } /** * Represents tables and fileset metadata contained within a zone. */ @@ -2357,6 +2259,10 @@ export namespace dataplex_v1 { * Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. */ name?: string | null; + /** + * Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API. + */ + transferStatus?: string | null; /** * Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. */ @@ -3933,7 +3839,7 @@ export namespace dataplex_v1 { */ sqlScript?: string | null; /** - * A reference to a query file. This can be the Cloud Storage URI of the query file or it can the path to a SqlScript Content. The execution args are used to declare a set of script variables (set key="value";). + * A reference to a query file. This should be the Cloud Storage URI of the query file. The execution args are used to declare a set of script variables (set key="value";). */ sqlScriptFile?: string | null; } @@ -5339,7 +5245,7 @@ export namespace dataplex_v1 { } /** - * Looks up a single Entry by name using the permission on the source system. + * Looks up a single Entry by name using the permission on the source system.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11655,7 +11561,7 @@ export namespace dataplex_v1 { } /** - * Gets an Entry. + * Gets an Entry.Caution: The BigQuery metadata that is stored in Dataplex Catalog is changing. For more information, see Changes to BigQuery metadata stored in Dataplex Catalog (https://cloud.google.com/dataplex/docs/biqquery-metadata-changes). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12007,7 +11913,7 @@ export namespace dataplex_v1 { */ allowMissing?: boolean; /** - * Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. + * Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. For example, to attach an aspect to a field that is specified by the schema aspect, the path should have the format Schema.. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. */ aspectKeys?: string[]; /** diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index b9aca39e44..d4c5b07eac 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -137,6 +137,138 @@ export namespace dataproc_v1 { */ acceleratorTypeUri?: string | null; } + /** + * Environment details of a Saprk Application. + */ + export interface Schema$AccessSessionSparkApplicationEnvironmentInfoResponse { + /** + * Details about the Environment that the application is running in. + */ + applicationEnvironmentInfo?: Schema$ApplicationEnvironmentInfo; + } + /** + * Details of a particular job associated with Spark Application + */ + export interface Schema$AccessSessionSparkApplicationJobResponse { + /** + * Output only. Data corresponding to a spark job. + */ + jobData?: Schema$JobData; + } + /** + * A summary of Spark Application + */ + export interface Schema$AccessSessionSparkApplicationResponse { + /** + * Output only. High level information corresponding to an application. + */ + application?: Schema$ApplicationInfo; + } + /** + * Details of a query for a Spark Application + */ + export interface Schema$AccessSessionSparkApplicationSqlQueryResponse { + /** + * SQL Execution Data + */ + executionData?: Schema$SqlExecutionUiData; + } + /** + * SparkPlanGraph for a Spark Application execution limited to maximum 10000 clusters. + */ + export interface Schema$AccessSessionSparkApplicationSqlSparkPlanGraphResponse { + /** + * SparkPlanGraph for a Spark Application execution. + */ + sparkPlanGraph?: Schema$SparkPlanGraph; + } + /** + * Stage Attempt for a Stage of a Spark Application + */ + export interface Schema$AccessSessionSparkApplicationStageAttemptResponse { + /** + * Output only. Data corresponding to a stage. + */ + stageData?: Schema$StageData; + } + /** + * RDD operation graph for a Spark Application Stage limited to maximum 10000 clusters. + */ + export interface Schema$AccessSessionSparkApplicationStageRddOperationGraphResponse { + /** + * RDD operation graph for a Spark Application Stage. + */ + rddOperationGraph?: Schema$RddOperationGraph; + } + /** + * Environment details of a Saprk Application. + */ + export interface Schema$AccessSparkApplicationEnvironmentInfoResponse { + /** + * Details about the Environment that the application is running in. + */ + applicationEnvironmentInfo?: Schema$ApplicationEnvironmentInfo; + } + /** + * Details of a particular job associated with Spark Application + */ + export interface Schema$AccessSparkApplicationJobResponse { + /** + * Output only. Data corresponding to a spark job. + */ + jobData?: Schema$JobData; + } + /** + * A summary of Spark Application + */ + export interface Schema$AccessSparkApplicationResponse { + /** + * Output only. High level information corresponding to an application. + */ + application?: Schema$ApplicationInfo; + } + /** + * Details of a query for a Spark Application + */ + export interface Schema$AccessSparkApplicationSqlQueryResponse { + /** + * SQL Execution Data + */ + executionData?: Schema$SqlExecutionUiData; + } + /** + * SparkPlanGraph for a Spark Application execution limited to maximum 10000 clusters. + */ + export interface Schema$AccessSparkApplicationSqlSparkPlanGraphResponse { + /** + * SparkPlanGraph for a Spark Application execution. + */ + sparkPlanGraph?: Schema$SparkPlanGraph; + } + /** + * Stage Attempt for a Stage of a Spark Application + */ + export interface Schema$AccessSparkApplicationStageAttemptResponse { + /** + * Output only. Data corresponding to a stage. + */ + stageData?: Schema$StageData; + } + /** + * RDD operation graph for a Spark Application Stage limited to maximum 10000 clusters. + */ + export interface Schema$AccessSparkApplicationStageRddOperationGraphResponse { + /** + * RDD operation graph for a Spark Application Stage. + */ + rddOperationGraph?: Schema$RddOperationGraph; + } + export interface Schema$AccumulableInfo { + accumullableInfoId?: string | null; + name?: string | null; + update?: string | null; + value?: string | null; + } /** * A request to analyze a batch workload. */ @@ -183,6 +315,49 @@ export namespace dataproc_v1 { */ warnings?: string[] | null; } + /** + * Specific attempt of an application. + */ + export interface Schema$ApplicationAttemptInfo { + appSparkVersion?: string | null; + attemptId?: string | null; + completed?: boolean | null; + durationMillis?: string | null; + endTime?: string | null; + lastUpdated?: string | null; + sparkUser?: string | null; + startTime?: string | null; + } + /** + * Details about the Environment that the application is running in. + */ + export interface Schema$ApplicationEnvironmentInfo { + classpathEntries?: {[key: string]: string} | null; + hadoopProperties?: {[key: string]: string} | null; + metricsProperties?: {[key: string]: string} | null; + resourceProfiles?: Schema$ResourceProfileInfo[]; + runtime?: Schema$SparkRuntimeInfo; + sparkProperties?: {[key: string]: string} | null; + systemProperties?: {[key: string]: string} | null; + } + /** + * High level information corresponding to an application. + */ + export interface Schema$ApplicationInfo { + applicationContextIngestionStatus?: string | null; + applicationId?: string | null; + attempts?: Schema$ApplicationAttemptInfo[]; + coresGranted?: number | null; + coresPerExecutor?: number | null; + maxCores?: number | null; + memoryPerExecutorMb?: number | null; + name?: string | null; + quantileDataStatus?: string | null; + } + export interface Schema$AppSummary { + numCompletedJobs?: number | null; + numCompletedStages?: number | null; + } /** * Autoscaling Policy config associated with the cluster. */ @@ -666,6 +841,15 @@ export namespace dataproc_v1 { */ substate?: string | null; } + /** + * Cluster to be repaired + */ + export interface Schema$ClusterToRepair { + /** + * Required. Repair action to take on the cluster resource. + */ + clusterRepairAction?: string | null; + } /** * Confidential Instance Config for clusters using Confidential VMs (https://cloud.google.com/compute/confidential-vm/docs) */ @@ -675,6 +859,28 @@ export namespace dataproc_v1 { */ enableConfidentialCompute?: boolean | null; } + /** + * Consolidated summary about executors used by the application. + */ + export interface Schema$ConsolidatedExecutorSummary { + activeTasks?: number | null; + completedTasks?: number | null; + count?: number | null; + diskUsed?: string | null; + failedTasks?: number | null; + isExcluded?: number | null; + maxMemory?: string | null; + memoryMetrics?: Schema$MemoryMetrics; + memoryUsed?: string | null; + rddBlocks?: number | null; + totalCores?: number | null; + totalDurationMillis?: string | null; + totalGcTimeMillis?: string | null; + totalInputBytes?: string | null; + totalShuffleRead?: string | null; + totalShuffleWrite?: string | null; + totalTasks?: number | null; + } /** * Dataproc metric config. */ @@ -848,6 +1054,98 @@ export namespace dataproc_v1 { */ ttl?: string | null; } + export interface Schema$ExecutorMetrics { + metrics?: {[key: string]: string} | null; + } + export interface Schema$ExecutorMetricsDistributions { + diskBytesSpilled?: number[] | null; + failedTasks?: number[] | null; + inputBytes?: number[] | null; + inputRecords?: number[] | null; + killedTasks?: number[] | null; + memoryBytesSpilled?: number[] | null; + outputBytes?: number[] | null; + outputRecords?: number[] | null; + peakMemoryMetrics?: Schema$ExecutorPeakMetricsDistributions; + quantiles?: number[] | null; + shuffleRead?: number[] | null; + shuffleReadRecords?: number[] | null; + shuffleWrite?: number[] | null; + shuffleWriteRecords?: number[] | null; + succeededTasks?: number[] | null; + taskTimeMillis?: number[] | null; + } + export interface Schema$ExecutorPeakMetricsDistributions { + executorMetrics?: Schema$ExecutorMetrics[]; + quantiles?: number[] | null; + } + /** + * Resources used per executor used by the application. + */ + export interface Schema$ExecutorResourceRequest { + amount?: string | null; + discoveryScript?: string | null; + resourceName?: string | null; + vendor?: string | null; + } + /** + * Executor resources consumed by a stage. + */ + export interface Schema$ExecutorStageSummary { + diskBytesSpilled?: string | null; + executorId?: string | null; + failedTasks?: number | null; + inputBytes?: string | null; + inputRecords?: string | null; + isExcludedForStage?: boolean | null; + killedTasks?: number | null; + memoryBytesSpilled?: string | null; + outputBytes?: string | null; + outputRecords?: string | null; + peakMemoryMetrics?: Schema$ExecutorMetrics; + shuffleRead?: string | null; + shuffleReadRecords?: string | null; + shuffleWrite?: string | null; + shuffleWriteRecords?: string | null; + stageAttemptId?: number | null; + stageId?: string | null; + succeededTasks?: number | null; + taskTimeMillis?: string | null; + } + /** + * Details about executors used by the application. + */ + export interface Schema$ExecutorSummary { + activeTasks?: number | null; + addTime?: string | null; + attributes?: {[key: string]: string} | null; + completedTasks?: number | null; + diskUsed?: string | null; + excludedInStages?: string[] | null; + executorId?: string | null; + executorLogs?: {[key: string]: string} | null; + failedTasks?: number | null; + hostPort?: string | null; + isActive?: boolean | null; + isExcluded?: boolean | null; + maxMemory?: string | null; + maxTasks?: number | null; + memoryMetrics?: Schema$MemoryMetrics; + memoryUsed?: string | null; + peakMemoryMetrics?: Schema$ExecutorMetrics; + rddBlocks?: number | null; + removeReason?: string | null; + removeTime?: string | null; + resourceProfileId?: number | null; + resources?: {[key: string]: Schema$ResourceInformation} | null; + totalCores?: number | null; + totalDurationMillis?: string | null; + totalGcTimeMillis?: string | null; + totalInputBytes?: string | null; + totalShuffleRead?: string | null; + totalShuffleWrite?: string | null; + totalTasks?: number | null; + } /** * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ @@ -894,7 +1192,7 @@ export namespace dataproc_v1 { */ mainJarFileUri?: string | null; /** - * Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might beoverwritten. Can include properties set in/etc/flink/conf/flink-defaults.conf and classes in user code. + * Optional. A mapping of property names to values, used to configure Flink. Properties that conflict with values set by the Dataproc API might be overwritten. Can include properties set in /etc/flink/conf/flink-defaults.conf and classes in user code. */ properties?: {[key: string]: string} | null; /** @@ -1188,6 +1486,17 @@ export namespace dataproc_v1 { */ credentialsCiphertext?: string | null; } + /** + * Metrics about the input data read by the task. + */ + export interface Schema$InputMetrics { + bytesRead?: string | null; + recordsRead?: string | null; + } + export interface Schema$InputQuantileMetrics { + bytesRead?: Schema$Quantiles; + recordsRead?: Schema$Quantiles; + } /** * Instance flexibility Policy allowing a mixture of VM shapes and provisioning models. */ @@ -1200,6 +1509,10 @@ export namespace dataproc_v1 { * Output only. A list of instance selection results in the group. */ instanceSelectionResults?: Schema$InstanceSelectionResult[]; + /** + * Optional. Defines how the Group selects the provisioning model to ensure required reliability. + */ + provisioningModelMix?: Schema$ProvisioningModelMix; } /** * Configuration for the size bounds of an instance group, including its proportional size to other groups. @@ -1449,6 +1762,33 @@ export namespace dataproc_v1 { */ yarnApplications?: Schema$YarnApplication[]; } + /** + * Data corresponding to a spark job. + */ + export interface Schema$JobData { + completionTime?: string | null; + description?: string | null; + jobGroup?: string | null; + jobId?: string | null; + killTasksSummary?: {[key: string]: number} | null; + name?: string | null; + numActiveStages?: number | null; + numActiveTasks?: number | null; + numCompletedIndices?: number | null; + numCompletedStages?: number | null; + numCompletedTasks?: number | null; + numFailedStages?: number | null; + numFailedTasks?: number | null; + numKilledTasks?: number | null; + numSkippedStages?: number | null; + numSkippedTasks?: number | null; + numTasks?: number | null; + skippedStages?: number[] | null; + sqlExecutionId?: string | null; + stageIds?: string[] | null; + status?: string | null; + submissionTime?: string | null; + } /** * Job Operation metadata. */ @@ -1513,6 +1853,35 @@ export namespace dataproc_v1 { */ maxFailuresTotal?: number | null; } + /** + * Data related to Jobs page summary + */ + export interface Schema$JobsSummary { + /** + * Number of active jobs + */ + activeJobs?: number | null; + /** + * Spark Application Id + */ + applicationId?: string | null; + /** + * Attempts info + */ + attempts?: Schema$ApplicationAttemptInfo[]; + /** + * Number of completed jobs + */ + completedJobs?: number | null; + /** + * Number of failed jobs + */ + failedJobs?: number | null; + /** + * Spark Scheduling mode + */ + schedulingMode?: string | null; + } /** * Dataproc job status. */ @@ -1822,6 +2191,12 @@ export namespace dataproc_v1 { */ instanceTemplateName?: string | null; } + export interface Schema$MemoryMetrics { + totalOffHeapStorageMemory?: string | null; + totalOnHeapStorageMemory?: string | null; + usedOffHeapStorageMemory?: string | null; + usedOnHeapStorageMemory?: string | null; + } /** * Specifies a Metastore configuration. */ @@ -1862,7 +2237,7 @@ export namespace dataproc_v1 { */ export interface Schema$NodeGroup { /** - * Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn. + * Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labels. */ labels?: {[key: string]: string} | null; /** @@ -2040,6 +2415,17 @@ export namespace dataproc_v1 { */ trinoJob?: Schema$TrinoJob; } + /** + * Metrics about the data written by the task. + */ + export interface Schema$OutputMetrics { + bytesWritten?: string | null; + recordsWritten?: string | null; + } + export interface Schema$OutputQuantileMetrics { + bytesWritten?: Schema$Quantiles; + recordsWritten?: Schema$Quantiles; + } /** * Configuration for parameter validation. */ @@ -2116,6 +2502,13 @@ export namespace dataproc_v1 { */ version?: number | null; } + /** + * Pool Data + */ + export interface Schema$PoolData { + name?: string | null; + stageIds?: string[] | null; + } /** * A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. */ @@ -2149,6 +2542,31 @@ export namespace dataproc_v1 { */ queryList?: Schema$QueryList; } + /** + * Process Summary + */ + export interface Schema$ProcessSummary { + addTime?: string | null; + hostPort?: string | null; + isActive?: boolean | null; + processId?: string | null; + processLogs?: {[key: string]: string} | null; + removeTime?: string | null; + totalCores?: number | null; + } + /** + * Defines how Dataproc should create VMs with a mixture of provisioning models. + */ + export interface Schema$ProvisioningModelMix { + /** + * Optional. The base capacity that will always use Standard VMs to avoid risk of more preemption than the minimum capacity you need. Dataproc will create only standard VMs until it reaches standard_capacity_base, then it will start using standard_capacity_percent_above_base to mix Spot with Standard VMs. eg. If 15 instances are requested and standard_capacity_base is 5, Dataproc will create 5 standard VMs and then start mixing spot and standard VMs for remaining 10 instances. + */ + standardCapacityBase?: number | null; + /** + * Optional. The percentage of target capacity that should use Standard VM. The remaining percentage will use Spot VMs. The percentage applies only to the capacity above standard_capacity_base. eg. If 15 instances are requested and standard_capacity_base is 5 and standard_capacity_percent_above_base is 30, Dataproc will create 5 standard VMs and then start mixing spot and standard VMs for remaining 10 instances. The mix will be 30% standard and 70% spot. + */ + standardCapacityPercentAboveBase?: number | null; + } /** * Configuration for PyPi repository */ @@ -2224,6 +2642,18 @@ export namespace dataproc_v1 { */ pythonFileUris?: string[] | null; } + /** + * Quantile metrics data related to Tasks. Units can be seconds, bytes, milliseconds, etc depending on the message type. + */ + export interface Schema$Quantiles { + count?: string | null; + maximum?: string | null; + minimum?: string | null; + percentile25?: string | null; + percentile50?: string | null; + percentile75?: string | null; + sum?: string | null; + } /** * A list of queries to run on a cluster. */ @@ -2233,6 +2663,80 @@ export namespace dataproc_v1 { */ queries?: string[] | null; } + /** + * Details about RDD usage. + */ + export interface Schema$RddDataDistribution { + address?: string | null; + diskUsed?: string | null; + memoryRemaining?: string | null; + memoryUsed?: string | null; + offHeapMemoryRemaining?: string | null; + offHeapMemoryUsed?: string | null; + onHeapMemoryRemaining?: string | null; + onHeapMemoryUsed?: string | null; + } + /** + * A grouping of nodes representing higher level constructs (stage, job etc.). + */ + export interface Schema$RddOperationCluster { + childClusters?: Schema$RddOperationCluster[]; + childNodes?: Schema$RddOperationNode[]; + name?: string | null; + rddClusterId?: string | null; + } + /** + * A directed edge representing dependency between two RDDs. + */ + export interface Schema$RddOperationEdge { + fromId?: number | null; + toId?: number | null; + } + /** + * Graph representing RDD dependencies. Consists of edges and a root cluster. + */ + export interface Schema$RddOperationGraph { + edges?: Schema$RddOperationEdge[]; + incomingEdges?: Schema$RddOperationEdge[]; + outgoingEdges?: Schema$RddOperationEdge[]; + rootCluster?: Schema$RddOperationCluster; + stageId?: string | null; + } + /** + * A node in the RDD operation graph. Corresponds to a single RDD. + */ + export interface Schema$RddOperationNode { + barrier?: boolean | null; + cached?: boolean | null; + callsite?: string | null; + name?: string | null; + nodeId?: number | null; + outputDeterministicLevel?: string | null; + } + /** + * Information about RDD partitions. + */ + export interface Schema$RddPartitionInfo { + blockName?: string | null; + diskUsed?: string | null; + executors?: string[] | null; + memoryUsed?: string | null; + storageLevel?: string | null; + } + /** + * Overall data about RDD storage. + */ + export interface Schema$RddStorageInfo { + dataDistribution?: Schema$RddDataDistribution[]; + diskUsed?: string | null; + memoryUsed?: string | null; + name?: string | null; + numCachedPartitions?: number | null; + numPartitions?: number | null; + partitions?: Schema$RddPartitionInfo[]; + rddStorageId?: number | null; + storageLevel?: string | null; + } /** * Validation based on regular expressions. */ @@ -2246,6 +2750,10 @@ export namespace dataproc_v1 { * A request to repair a cluster. */ export interface Schema$RepairClusterRequest { + /** + * Optional. Cluster to be repaired + */ + cluster?: Schema$ClusterToRepair; /** * Optional. Specifying the cluster_uuid means the RPC will fail (with error NOT_FOUND) if a cluster with the specified UUID does not exist. */ @@ -2328,6 +2836,18 @@ export namespace dataproc_v1 { */ size?: number | null; } + export interface Schema$ResourceInformation { + addresses?: string[] | null; + name?: string | null; + } + /** + * Resource profile that contains information about all the resources required by executors and tasks. + */ + export interface Schema$ResourceProfileInfo { + executorResources?: {[key: string]: Schema$ExecutorResourceRequest} | null; + resourceProfileId?: number | null; + taskResources?: {[key: string]: Schema$TaskResourceRequest} | null; + } /** * Runtime configuration for a workload. */ @@ -2383,89 +2903,297 @@ export namespace dataproc_v1 { outputUri?: string | null; } /** - * Security related configuration, including encryption, Kerberos, etc. + * List of Executors associated with a Spark Application. */ - export interface Schema$SecurityConfig { + export interface Schema$SearchSessionSparkApplicationExecutorsResponse { /** - * Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationExecutorsRequest. */ - identityConfig?: Schema$IdentityConfig; + nextPageToken?: string | null; /** - * Optional. Kerberos related configuration. + * Details about executors used by the application. */ - kerberosConfig?: Schema$KerberosConfig; + sparkApplicationExecutors?: Schema$ExecutorSummary[]; } /** - * A representation of a session. + * List of Executors associated with a Spark Application Stage. */ - export interface Schema$Session { + export interface Schema$SearchSessionSparkApplicationExecutorStageSummaryResponse { /** - * Output only. The time when the session was created. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationExecutorStageSummaryRequest. */ - createTime?: string | null; + nextPageToken?: string | null; /** - * Output only. The email address of the user who created the session. + * Details about executors used by the application stage. */ - creator?: string | null; + sparkApplicationStageExecutors?: Schema$ExecutorStageSummary[]; + } + /** + * A list of Jobs associated with a Spark Application. + */ + export interface Schema$SearchSessionSparkApplicationJobsResponse { /** - * Optional. Environment configuration for the session execution. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationJobsRequest. */ - environmentConfig?: Schema$EnvironmentConfig; + nextPageToken?: string | null; /** - * Optional. Jupyter session config. + * Output only. Data corresponding to a spark job. */ - jupyterSession?: Schema$JupyterConfig; + sparkApplicationJobs?: Schema$JobData[]; + } + /** + * List of all queries for a Spark Application. + */ + export interface Schema$SearchSessionSparkApplicationSqlQueriesResponse { /** - * Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationSqlQueriesRequest. */ - labels?: {[key: string]: string} | null; + nextPageToken?: string | null; /** - * Required. The resource name of the session. + * Output only. SQL Execution Data */ - name?: string | null; + sparkApplicationSqlQueries?: Schema$SqlExecutionUiData[]; + } + /** + * A list of summary of Spark Applications + */ + export interface Schema$SearchSessionSparkApplicationsResponse { /** - * Optional. Runtime configuration for the session execution. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationsRequest. */ - runtimeConfig?: Schema$RuntimeConfig; + nextPageToken?: string | null; /** - * Output only. Runtime information about session execution. + * Output only. High level information corresponding to an application. */ - runtimeInfo?: Schema$RuntimeInfo; + sparkApplications?: Schema$SparkApplication[]; + } + /** + * A list of Stage Attempts for a Stage of a Spark Application. + */ + export interface Schema$SearchSessionSparkApplicationStageAttemptsResponse { /** - * Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStageAttemptsRequest. */ - sessionTemplate?: string | null; + nextPageToken?: string | null; /** - * Optional. Spark connect session config. + * Output only. Data corresponding to a stage attempts */ - sparkConnectSession?: Schema$SparkConnectConfig; + sparkApplicationStageAttempts?: Schema$StageData[]; + } + /** + * List of tasks for a stage of a Spark Application + */ + export interface Schema$SearchSessionSparkApplicationStageAttemptTasksResponse { /** - * Output only. A state of the session. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStageAttemptTasksRequest. */ - state?: string | null; + nextPageToken?: string | null; /** - * Output only. Historical state information for the session. + * Output only. Data corresponding to tasks created by spark. */ - stateHistory?: Schema$SessionStateHistory[]; + sparkApplicationStageAttemptTasks?: Schema$TaskData[]; + } + /** + * A list of stages associated with a Spark Application. + */ + export interface Schema$SearchSessionSparkApplicationStagesResponse { /** - * Output only. Session state details, such as the failure description if the state is FAILED. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSessionSparkApplicationStages. */ - stateMessage?: string | null; + nextPageToken?: string | null; /** - * Output only. The time when the session entered the current state. + * Output only. Data corresponding to a stage. */ - stateTime?: string | null; + sparkApplicationStages?: Schema$StageData[]; + } + /** + * List of Executors associated with a Spark Application. + */ + export interface Schema$SearchSparkApplicationExecutorsResponse { /** - * Optional. The email address of the user who owns the session. + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationExecutorsListRequest. */ - user?: string | null; + nextPageToken?: string | null; /** - * Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. + * Details about executors used by the application. */ - uuid?: string | null; + sparkApplicationExecutors?: Schema$ExecutorSummary[]; } /** - * Metadata describing the Session operation. + * List of Executors associated with a Spark Application Stage. + */ + export interface Schema$SearchSparkApplicationExecutorStageSummaryResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationExecutorsListRequest. + */ + nextPageToken?: string | null; + /** + * Details about executors used by the application stage. + */ + sparkApplicationStageExecutors?: Schema$ExecutorStageSummary[]; + } + /** + * A list of Jobs associated with a Spark Application. + */ + export interface Schema$SearchSparkApplicationJobsResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationJobsRequest. + */ + nextPageToken?: string | null; + /** + * Output only. Data corresponding to a spark job. + */ + sparkApplicationJobs?: Schema$JobData[]; + } + /** + * List of all queries for a Spark Application. + */ + export interface Schema$SearchSparkApplicationSqlQueriesResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationSqlQueriesRequest. + */ + nextPageToken?: string | null; + /** + * Output only. SQL Execution Data + */ + sparkApplicationSqlQueries?: Schema$SqlExecutionUiData[]; + } + /** + * A list of summary of Spark Applications + */ + export interface Schema$SearchSparkApplicationsResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationsRequest. + */ + nextPageToken?: string | null; + /** + * Output only. High level information corresponding to an application. + */ + sparkApplications?: Schema$SparkApplication[]; + } + /** + * A list of Stage Attempts for a Stage of a Spark Application. + */ + export interface Schema$SearchSparkApplicationStageAttemptsResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListSparkApplicationStageAttemptsRequest. + */ + nextPageToken?: string | null; + /** + * Output only. Data corresponding to a stage attempts + */ + sparkApplicationStageAttempts?: Schema$StageData[]; + } + /** + * List of tasks for a stage of a Spark Application + */ + export interface Schema$SearchSparkApplicationStageAttemptTasksResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListSparkApplicationStageAttemptTasksRequest. + */ + nextPageToken?: string | null; + /** + * Output only. Data corresponding to tasks created by spark. + */ + sparkApplicationStageAttemptTasks?: Schema$TaskData[]; + } + /** + * A list of stages associated with a Spark Application. + */ + export interface Schema$SearchSparkApplicationStagesResponse { + /** + * This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent SearchSparkApplicationStages. + */ + nextPageToken?: string | null; + /** + * Output only. Data corresponding to a stage. + */ + sparkApplicationStages?: Schema$StageData[]; + } + /** + * Security related configuration, including encryption, Kerberos, etc. + */ + export interface Schema$SecurityConfig { + /** + * Optional. Identity related configuration, including service account based secure multi-tenancy user mappings. + */ + identityConfig?: Schema$IdentityConfig; + /** + * Optional. Kerberos related configuration. + */ + kerberosConfig?: Schema$KerberosConfig; + } + /** + * A representation of a session. + */ + export interface Schema$Session { + /** + * Output only. The time when the session was created. + */ + createTime?: string | null; + /** + * Output only. The email address of the user who created the session. + */ + creator?: string | null; + /** + * Optional. Environment configuration for the session execution. + */ + environmentConfig?: Schema$EnvironmentConfig; + /** + * Optional. Jupyter session config. + */ + jupyterSession?: Schema$JupyterConfig; + /** + * Optional. The labels to associate with the session. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a session. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The resource name of the session. + */ + name?: string | null; + /** + * Optional. Runtime configuration for the session execution. + */ + runtimeConfig?: Schema$RuntimeConfig; + /** + * Output only. Runtime information about session execution. + */ + runtimeInfo?: Schema$RuntimeInfo; + /** + * Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. + */ + sessionTemplate?: string | null; + /** + * Optional. Spark connect session config. + */ + sparkConnectSession?: Schema$SparkConnectConfig; + /** + * Output only. A state of the session. + */ + state?: string | null; + /** + * Output only. Historical state information for the session. + */ + stateHistory?: Schema$SessionStateHistory[]; + /** + * Output only. Session state details, such as the failure description if the state is FAILED. + */ + stateMessage?: string | null; + /** + * Output only. The time when the session entered the current state. + */ + stateTime?: string | null; + /** + * Optional. The email address of the user who owns the session. + */ + user?: string | null; + /** + * Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. + */ + uuid?: string | null; + } + /** + * Metadata describing the Session operation. */ export interface Schema$SessionOperationMetadata { /** @@ -2593,6 +3321,72 @@ export namespace dataproc_v1 { */ enableVtpm?: boolean | null; } + export interface Schema$ShufflePushReadMetrics { + corruptMergedBlockChunks?: string | null; + localMergedBlocksFetched?: string | null; + localMergedBytesRead?: string | null; + localMergedChunksFetched?: string | null; + mergedFetchFallbackCount?: string | null; + remoteMergedBlocksFetched?: string | null; + remoteMergedBytesRead?: string | null; + remoteMergedChunksFetched?: string | null; + remoteMergedReqsDuration?: string | null; + } + export interface Schema$ShufflePushReadQuantileMetrics { + corruptMergedBlockChunks?: Schema$Quantiles; + localMergedBlocksFetched?: Schema$Quantiles; + localMergedBytesRead?: Schema$Quantiles; + localMergedChunksFetched?: Schema$Quantiles; + mergedFetchFallbackCount?: Schema$Quantiles; + remoteMergedBlocksFetched?: Schema$Quantiles; + remoteMergedBytesRead?: Schema$Quantiles; + remoteMergedChunksFetched?: Schema$Quantiles; + remoteMergedReqsDuration?: Schema$Quantiles; + } + /** + * Shuffle data read by the task. + */ + export interface Schema$ShuffleReadMetrics { + fetchWaitTimeMillis?: string | null; + localBlocksFetched?: string | null; + localBytesRead?: string | null; + recordsRead?: string | null; + remoteBlocksFetched?: string | null; + remoteBytesRead?: string | null; + remoteBytesReadToDisk?: string | null; + remoteReqsDuration?: string | null; + shufflePushReadMetrics?: Schema$ShufflePushReadMetrics; + } + export interface Schema$ShuffleReadQuantileMetrics { + fetchWaitTimeMillis?: Schema$Quantiles; + localBlocksFetched?: Schema$Quantiles; + readBytes?: Schema$Quantiles; + readRecords?: Schema$Quantiles; + remoteBlocksFetched?: Schema$Quantiles; + remoteBytesRead?: Schema$Quantiles; + remoteBytesReadToDisk?: Schema$Quantiles; + remoteReqsDuration?: Schema$Quantiles; + shufflePushReadMetrics?: Schema$ShufflePushReadQuantileMetrics; + totalBlocksFetched?: Schema$Quantiles; + } + /** + * Shuffle data written by task. + */ + export interface Schema$ShuffleWriteMetrics { + bytesWritten?: string | null; + recordsWritten?: string | null; + writeTimeNanos?: string | null; + } + export interface Schema$ShuffleWriteQuantileMetrics { + writeBytes?: Schema$Quantiles; + writeRecords?: Schema$Quantiles; + writeTimeNanos?: Schema$Quantiles; + } + export interface Schema$SinkProgress { + description?: string | null; + metrics?: {[key: string]: string} | null; + numOutputRows?: string | null; + } /** * Specifies the selection and config of software inside the cluster. */ @@ -2610,6 +3404,29 @@ export namespace dataproc_v1 { */ properties?: {[key: string]: string} | null; } + export interface Schema$SourceProgress { + description?: string | null; + endOffset?: string | null; + inputRowsPerSecond?: number | null; + latestOffset?: string | null; + metrics?: {[key: string]: string} | null; + numInputRows?: string | null; + processedRowsPerSecond?: number | null; + startOffset?: string | null; + } + /** + * A summary of Spark Application + */ + export interface Schema$SparkApplication { + /** + * Output only. High level information corresponding to an application. + */ + application?: Schema$ApplicationInfo; + /** + * Identifier. Name of the spark application + */ + name?: string | null; + } /** * A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. */ @@ -2689,6 +3506,47 @@ export namespace dataproc_v1 { */ properties?: {[key: string]: string} | null; } + /** + * A graph used for storing information of an executionPlan of DataFrame. + */ + export interface Schema$SparkPlanGraph { + edges?: Schema$SparkPlanGraphEdge[]; + executionId?: string | null; + nodes?: Schema$SparkPlanGraphNodeWrapper[]; + } + /** + * Represents a tree of spark plan. + */ + export interface Schema$SparkPlanGraphCluster { + desc?: string | null; + metrics?: Schema$SqlPlanMetric[]; + name?: string | null; + nodes?: Schema$SparkPlanGraphNodeWrapper[]; + sparkPlanGraphClusterId?: string | null; + } + /** + * Represents a directed edge in the spark plan tree from child to parent. + */ + export interface Schema$SparkPlanGraphEdge { + fromId?: string | null; + toId?: string | null; + } + /** + * Represents a node in the spark plan tree. + */ + export interface Schema$SparkPlanGraphNode { + desc?: string | null; + metrics?: Schema$SqlPlanMetric[]; + name?: string | null; + sparkPlanGraphNodeId?: string | null; + } + /** + * Wrapper user to represent either a node or a cluster. + */ + export interface Schema$SparkPlanGraphNodeWrapper { + cluster?: Schema$SparkPlanGraphCluster; + node?: Schema$SparkPlanGraphNode; + } /** * A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. */ @@ -2739,6 +3597,11 @@ export namespace dataproc_v1 { */ properties?: {[key: string]: string} | null; } + export interface Schema$SparkRuntimeInfo { + javaHome?: string | null; + javaVersion?: string | null; + scalaVersion?: string | null; + } /** * A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload. */ @@ -2814,6 +3677,210 @@ export namespace dataproc_v1 { */ scaleUpMinWorkerFraction?: number | null; } + /** + * Outer message that contains the data obtained from spark listener, packaged with information that is required to process it. + */ + export interface Schema$SparkWrapperObject { + applicationEnvironmentInfo?: Schema$ApplicationEnvironmentInfo; + /** + * Application Id created by Spark. + */ + applicationId?: string | null; + applicationInfo?: Schema$ApplicationInfo; + appSummary?: Schema$AppSummary; + /** + * VM Timestamp associated with the data object. + */ + eventTimestamp?: string | null; + executorStageSummary?: Schema$ExecutorStageSummary; + executorSummary?: Schema$ExecutorSummary; + jobData?: Schema$JobData; + poolData?: Schema$PoolData; + processSummary?: Schema$ProcessSummary; + rddOperationGraph?: Schema$RddOperationGraph; + rddStorageInfo?: Schema$RddStorageInfo; + resourceProfileInfo?: Schema$ResourceProfileInfo; + sparkPlanGraph?: Schema$SparkPlanGraph; + speculationStageSummary?: Schema$SpeculationStageSummary; + sqlExecutionUiData?: Schema$SqlExecutionUiData; + stageData?: Schema$StageData; + streamBlockData?: Schema$StreamBlockData; + streamingQueryData?: Schema$StreamingQueryData; + streamingQueryProgress?: Schema$StreamingQueryProgress; + taskData?: Schema$TaskData; + } + /** + * Details of the speculation task when speculative execution is enabled. + */ + export interface Schema$SpeculationStageSummary { + numActiveTasks?: number | null; + numCompletedTasks?: number | null; + numFailedTasks?: number | null; + numKilledTasks?: number | null; + numTasks?: number | null; + stageAttemptId?: number | null; + stageId?: string | null; + } + /** + * SQL Execution Data + */ + export interface Schema$SqlExecutionUiData { + completionTime?: string | null; + description?: string | null; + details?: string | null; + errorMessage?: string | null; + executionId?: string | null; + jobs?: {[key: string]: string} | null; + metrics?: Schema$SqlPlanMetric[]; + metricValues?: {[key: string]: string} | null; + metricValuesIsNull?: boolean | null; + modifiedConfigs?: {[key: string]: string} | null; + physicalPlanDescription?: string | null; + rootExecutionId?: string | null; + stages?: string[] | null; + submissionTime?: string | null; + } + /** + * Metrics related to SQL execution. + */ + export interface Schema$SqlPlanMetric { + accumulatorId?: string | null; + metricType?: string | null; + name?: string | null; + } + /** + * Data related to tasks summary for a Spark Stage Attempt + */ + export interface Schema$StageAttemptTasksSummary { + applicationId?: string | null; + numFailedTasks?: number | null; + numKilledTasks?: number | null; + numPendingTasks?: number | null; + numRunningTasks?: number | null; + numSuccessTasks?: number | null; + numTasks?: number | null; + stageAttemptId?: number | null; + stageId?: string | null; + } + /** + * Data corresponding to a stage. + */ + export interface Schema$StageData { + accumulatorUpdates?: Schema$AccumulableInfo[]; + completionTime?: string | null; + description?: string | null; + details?: string | null; + executorMetricsDistributions?: Schema$ExecutorMetricsDistributions; + executorSummary?: {[key: string]: Schema$ExecutorStageSummary} | null; + failureReason?: string | null; + firstTaskLaunchedTime?: string | null; + isShufflePushEnabled?: boolean | null; + jobIds?: string[] | null; + killedTasksSummary?: {[key: string]: number} | null; + locality?: {[key: string]: string} | null; + name?: string | null; + numActiveTasks?: number | null; + numCompletedIndices?: number | null; + numCompleteTasks?: number | null; + numFailedTasks?: number | null; + numKilledTasks?: number | null; + numTasks?: number | null; + parentStageIds?: string[] | null; + peakExecutorMetrics?: Schema$ExecutorMetrics; + rddIds?: string[] | null; + resourceProfileId?: number | null; + schedulingPool?: string | null; + shuffleMergersCount?: number | null; + speculationSummary?: Schema$SpeculationStageSummary; + stageAttemptId?: number | null; + stageId?: string | null; + stageMetrics?: Schema$StageMetrics; + status?: string | null; + submissionTime?: string | null; + /** + * Summary metrics fields. These are included in response only if present in summary_metrics_mask field in request + */ + taskQuantileMetrics?: Schema$TaskQuantileMetrics; + tasks?: {[key: string]: Schema$TaskData} | null; + } + /** + * Metrics about the input read by the stage. + */ + export interface Schema$StageInputMetrics { + bytesRead?: string | null; + recordsRead?: string | null; + } + /** + * Stage Level Aggregated Metrics + */ + export interface Schema$StageMetrics { + diskBytesSpilled?: string | null; + executorCpuTimeNanos?: string | null; + executorDeserializeCpuTimeNanos?: string | null; + executorDeserializeTimeMillis?: string | null; + executorRunTimeMillis?: string | null; + jvmGcTimeMillis?: string | null; + memoryBytesSpilled?: string | null; + peakExecutionMemoryBytes?: string | null; + resultSerializationTimeMillis?: string | null; + resultSize?: string | null; + stageInputMetrics?: Schema$StageInputMetrics; + stageOutputMetrics?: Schema$StageOutputMetrics; + stageShuffleReadMetrics?: Schema$StageShuffleReadMetrics; + stageShuffleWriteMetrics?: Schema$StageShuffleWriteMetrics; + } + /** + * Metrics about the output written by the stage. + */ + export interface Schema$StageOutputMetrics { + bytesWritten?: string | null; + recordsWritten?: string | null; + } + export interface Schema$StageShufflePushReadMetrics { + corruptMergedBlockChunks?: string | null; + localMergedBlocksFetched?: string | null; + localMergedBytesRead?: string | null; + localMergedChunksFetched?: string | null; + mergedFetchFallbackCount?: string | null; + remoteMergedBlocksFetched?: string | null; + remoteMergedBytesRead?: string | null; + remoteMergedChunksFetched?: string | null; + remoteMergedReqsDuration?: string | null; + } + /** + * Shuffle data read for the stage. + */ + export interface Schema$StageShuffleReadMetrics { + bytesRead?: string | null; + fetchWaitTimeMillis?: string | null; + localBlocksFetched?: string | null; + localBytesRead?: string | null; + recordsRead?: string | null; + remoteBlocksFetched?: string | null; + remoteBytesRead?: string | null; + remoteBytesReadToDisk?: string | null; + remoteReqsDuration?: string | null; + stageShufflePushReadMetrics?: Schema$StageShufflePushReadMetrics; + } + /** + * Shuffle data written for the stage. + */ + export interface Schema$StageShuffleWriteMetrics { + bytesWritten?: string | null; + recordsWritten?: string | null; + writeTimeNanos?: string | null; + } + /** + * Data related to Stages page summary + */ + export interface Schema$StagesSummary { + applicationId?: string | null; + numActiveStages?: number | null; + numCompletedStages?: number | null; + numFailedStages?: number | null; + numPendingStages?: number | null; + numSkippedStages?: number | null; + } /** * A request to start a cluster. */ @@ -2853,6 +3920,20 @@ export namespace dataproc_v1 { */ stateStartTime?: string | null; } + export interface Schema$StateOperatorProgress { + allRemovalsTimeMs?: string | null; + allUpdatesTimeMs?: string | null; + commitTimeMs?: string | null; + customMetrics?: {[key: string]: string} | null; + memoryUsedBytes?: string | null; + numRowsDroppedByWatermark?: string | null; + numRowsRemoved?: string | null; + numRowsTotal?: string | null; + numRowsUpdated?: string | null; + numShufflePartitions?: string | null; + numStateStoreInstances?: string | null; + operatorName?: 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). */ @@ -2883,6 +3964,46 @@ export namespace dataproc_v1 { */ requestId?: string | null; } + /** + * Stream Block Data. + */ + export interface Schema$StreamBlockData { + deserialized?: boolean | null; + diskSize?: string | null; + executorId?: string | null; + hostPort?: string | null; + memSize?: string | null; + name?: string | null; + storageLevel?: string | null; + useDisk?: boolean | null; + useMemory?: boolean | null; + } + /** + * Streaming + */ + export interface Schema$StreamingQueryData { + endTimestamp?: string | null; + exception?: string | null; + isActive?: boolean | null; + name?: string | null; + runId?: string | null; + startTimestamp?: string | null; + streamingQueryId?: string | null; + } + export interface Schema$StreamingQueryProgress { + batchDuration?: string | null; + batchId?: string | null; + durationMillis?: {[key: string]: string} | null; + eventTime?: {[key: string]: string} | null; + name?: string | null; + observedMetrics?: {[key: string]: string} | null; + runId?: string | null; + sink?: Schema$SinkProgress; + sources?: Schema$SourceProgress[]; + stateOperators?: Schema$StateOperatorProgress[]; + streamingQueryProgressId?: string | null; + timestamp?: string | null; + } /** * A request to submit a job. */ @@ -2897,55 +4018,222 @@ export namespace dataproc_v1 { requestId?: string | null; } /** - * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) + * Consolidated summary of executors for a Spark Application. */ - export interface Schema$TemplateParameter { + export interface Schema$SummarizeSessionSparkApplicationExecutorsResponse { /** - * Optional. Brief description of the parameter. Must not exceed 1024 characters. + * Consolidated summary for active executors. */ - description?: string | null; + activeExecutorSummary?: Schema$ConsolidatedExecutorSummary; /** - * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args + * Spark Application Id */ - fields?: string[] | null; + applicationId?: string | null; /** - * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. + * Consolidated summary for dead executors. */ - name?: string | null; + deadExecutorSummary?: Schema$ConsolidatedExecutorSummary; /** - * Optional. Validation rules to be applied to this parameter's value. + * Overall consolidated summary for all executors. */ - validation?: Schema$ParameterValidation; + totalExecutorSummary?: Schema$ConsolidatedExecutorSummary; } /** - * A request to terminate an interactive session. + * Summary of a Spark Application jobs. */ - export interface Schema$TerminateSessionRequest { + export interface Schema$SummarizeSessionSparkApplicationJobsResponse { /** - * Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.TerminateSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + * Summary of a Spark Application Jobs */ - requestId?: string | null; + jobsSummary?: Schema$JobsSummary; } /** - * Request message for TestIamPermissions method. + * Summary of tasks for a Spark Application stage attempt. */ - export interface Schema$TestIamPermissionsRequest { + export interface Schema$SummarizeSessionSparkApplicationStageAttemptTasksResponse { /** - * 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). + * Summary of tasks for a Spark Application Stage Attempt */ - permissions?: string[] | null; + stageAttemptTasksSummary?: Schema$StageAttemptTasksSummary; } /** - * Response message for TestIamPermissions method. + * Summary of a Spark Application stages. */ - export interface Schema$TestIamPermissionsResponse { + export interface Schema$SummarizeSessionSparkApplicationStagesResponse { /** - * A subset of TestPermissionsRequest.permissions that the caller is allowed. + * Summary of a Spark Application Stages */ - permissions?: string[] | null; + stagesSummary?: Schema$StagesSummary; } /** - * A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. + * Consolidated summary of executors for a Spark Application. + */ + export interface Schema$SummarizeSparkApplicationExecutorsResponse { + /** + * Consolidated summary for active executors. + */ + activeExecutorSummary?: Schema$ConsolidatedExecutorSummary; + /** + * Spark Application Id + */ + applicationId?: string | null; + /** + * Consolidated summary for dead executors. + */ + deadExecutorSummary?: Schema$ConsolidatedExecutorSummary; + /** + * Overall consolidated summary for all executors. + */ + totalExecutorSummary?: Schema$ConsolidatedExecutorSummary; + } + /** + * Summary of a Spark Application jobs. + */ + export interface Schema$SummarizeSparkApplicationJobsResponse { + /** + * Summary of a Spark Application Jobs + */ + jobsSummary?: Schema$JobsSummary; + } + /** + * Summary of tasks for a Spark Application stage attempt. + */ + export interface Schema$SummarizeSparkApplicationStageAttemptTasksResponse { + /** + * Summary of tasks for a Spark Application Stage Attempt + */ + stageAttemptTasksSummary?: Schema$StageAttemptTasksSummary; + } + /** + * Summary of a Spark Application stages. + */ + export interface Schema$SummarizeSparkApplicationStagesResponse { + /** + * Summary of a Spark Application Stages + */ + stagesSummary?: Schema$StagesSummary; + } + /** + * Data corresponding to tasks created by spark. + */ + export interface Schema$TaskData { + accumulatorUpdates?: Schema$AccumulableInfo[]; + attempt?: number | null; + durationMillis?: string | null; + errorMessage?: string | null; + executorId?: string | null; + executorLogs?: {[key: string]: string} | null; + gettingResultTimeMillis?: string | null; + hasMetrics?: boolean | null; + host?: string | null; + index?: number | null; + launchTime?: string | null; + partitionId?: number | null; + resultFetchStart?: string | null; + schedulerDelayMillis?: string | null; + speculative?: boolean | null; + stageAttemptId?: number | null; + stageId?: string | null; + status?: string | null; + taskId?: string | null; + taskLocality?: string | null; + taskMetrics?: Schema$TaskMetrics; + } + /** + * Executor Task Metrics + */ + export interface Schema$TaskMetrics { + diskBytesSpilled?: string | null; + executorCpuTimeNanos?: string | null; + executorDeserializeCpuTimeNanos?: string | null; + executorDeserializeTimeMillis?: string | null; + executorRunTimeMillis?: string | null; + inputMetrics?: Schema$InputMetrics; + jvmGcTimeMillis?: string | null; + memoryBytesSpilled?: string | null; + outputMetrics?: Schema$OutputMetrics; + peakExecutionMemoryBytes?: string | null; + resultSerializationTimeMillis?: string | null; + resultSize?: string | null; + shuffleReadMetrics?: Schema$ShuffleReadMetrics; + shuffleWriteMetrics?: Schema$ShuffleWriteMetrics; + } + export interface Schema$TaskQuantileMetrics { + diskBytesSpilled?: Schema$Quantiles; + durationMillis?: Schema$Quantiles; + executorCpuTimeNanos?: Schema$Quantiles; + executorDeserializeCpuTimeNanos?: Schema$Quantiles; + executorDeserializeTimeMillis?: Schema$Quantiles; + executorRunTimeMillis?: Schema$Quantiles; + gettingResultTimeMillis?: Schema$Quantiles; + inputMetrics?: Schema$InputQuantileMetrics; + jvmGcTimeMillis?: Schema$Quantiles; + memoryBytesSpilled?: Schema$Quantiles; + outputMetrics?: Schema$OutputQuantileMetrics; + peakExecutionMemoryBytes?: Schema$Quantiles; + resultSerializationTimeMillis?: Schema$Quantiles; + resultSize?: Schema$Quantiles; + schedulerDelayMillis?: Schema$Quantiles; + shuffleReadMetrics?: Schema$ShuffleReadQuantileMetrics; + shuffleWriteMetrics?: Schema$ShuffleWriteQuantileMetrics; + } + /** + * Resources used per task created by the application. + */ + export interface Schema$TaskResourceRequest { + amount?: number | null; + resourceName?: string | null; + } + /** + * A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector) + */ + export interface Schema$TemplateParameter { + /** + * Optional. Brief description of the parameter. Must not exceed 1024 characters. + */ + description?: string | null; + /** + * Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax: Values in maps can be referenced by key: labels'key' placement.clusterSelector.clusterLabels'key' placement.managedCluster.labels'key' placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' Jobs in the jobs list can be referenced by step-id: jobs'step-id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step-id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 jobs'step-id'.hadoopJob.fileUris0 jobs'step-id'.pySparkJob.pythonFileUris0 Items in repeated fields can be referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other examples: jobs'step-id'.hadoopJob.properties'key' jobs'step-id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: placement.clusterSelector.clusterLabels jobs'step-id'.sparkJob.args + */ + fields?: string[] | null; + /** + * Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters. + */ + name?: string | null; + /** + * Optional. Validation rules to be applied to this parameter's value. + */ + validation?: Schema$ParameterValidation; + } + /** + * A request to terminate an interactive session. + */ + export interface Schema$TerminateSessionRequest { + /** + * Optional. A unique ID used to identify the request. If the service receives two TerminateSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.TerminateSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string | null; + } + /** + * Request message for TestIamPermissions method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[] | null; + } + /** + * Response message for TestIamPermissions method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of TestPermissionsRequest.permissions that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. */ export interface Schema$TrinoJob { /** @@ -3211,6 +4499,37 @@ export namespace dataproc_v1 { */ managedCluster?: Schema$ManagedCluster; } + /** + * Write Spark Application data to internal storage systems + */ + export interface Schema$WriteSessionSparkApplicationContextRequest { + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string | null; + /** + * Required. The batch of spark application context objects sent for ingestion. + */ + sparkWrapperObjects?: Schema$SparkWrapperObject[]; + } + /** + * Response returned as an acknowledgement of receipt of data. + */ + export interface Schema$WriteSessionSparkApplicationContextResponse {} + /** + * Write Spark Application data to internal storage systems + */ + export interface Schema$WriteSparkApplicationContextRequest { + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string | null; + sparkWrapperObjects?: Schema$SparkWrapperObject[]; + } + /** + * Response returned as an acknowledgement of receipt of data. + */ + export interface Schema$WriteSparkApplicationContextResponse {} /** * A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta Feature: This report is available for testing purposes only. It may be changed before final release. */ @@ -4096,8 +5415,11 @@ export namespace dataproc_v1 { export class Resource$Projects$Locations$Batches { context: APIRequestContext; + sparkApplications: Resource$Projects$Locations$Batches$Sparkapplications; constructor(context: APIRequestContext) { this.context = context; + this.sparkApplications = + new Resource$Projects$Locations$Batches$Sparkapplications(this.context); } /** @@ -4608,64 +5930,72 @@ export namespace dataproc_v1 { parent?: string; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Batches$Sparkapplications { 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. + * Obtain high level information corresponding to a single Spark Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + access( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Access, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + access( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Access, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Access, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + access( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + access( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Access, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + access( + callback: BodyResponseCallback + ): void; + access( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Access + | 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$Batches$Sparkapplications$Access; 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$Batches$Sparkapplications$Access; options = {}; } @@ -4678,8 +6008,8 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}:access').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -4690,67 +6020,77 @@ export namespace dataproc_v1 { 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. + * Obtain environment details for a Spark Application * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + accessEnvironmentInfo( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): GaxiosPromise; + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + accessEnvironmentInfo( + callback: BodyResponseCallback + ): void; + accessEnvironmentInfo( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo + | 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$Batches$Sparkapplications$Accessenvironmentinfo; 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$Batches$Sparkapplications$Accessenvironmentinfo; options = {}; } @@ -4763,8 +6103,11 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:accessEnvironmentInfo').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -4775,67 +6118,77 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * Obtain data corresponding to a spark job for a Spark Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + accessJob( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + accessJob( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + accessJob( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + accessJob( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + accessJob( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + accessJob( + callback: BodyResponseCallback + ): void; + accessJob( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob; 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$Batches$Sparkapplications$Accessjob; options = {}; } @@ -4848,7 +6201,10 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:accessJob').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -4860,72 +6216,77 @@ export namespace dataproc_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. + * Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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, + accessSqlPlan( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + accessSqlPlan( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + accessSqlPlan( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + accessSqlPlan( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + accessSqlPlan( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + accessSqlPlan( + callback: BodyResponseCallback + ): void; + accessSqlPlan( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan + | 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$Batches$Sparkapplications$Accesssqlplan; 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$Batches$Sparkapplications$Accesssqlplan; options = {}; } @@ -4938,7 +6299,10 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:accessSqlPlan').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -4950,115 +6314,77 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - } - 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$Sessions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create an interactive session asynchronously. + * Obtain data corresponding to a particular SQL Query for a Spark Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Sessions$Create, + accessSqlQuery( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Sessions$Create, + accessSqlQuery( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Sessions$Create, + ): GaxiosPromise; + accessSqlQuery( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Sessions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + accessSqlQuery( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Sessions$Create, - callback: BodyResponseCallback + accessSqlQuery( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + accessSqlQuery( + callback: BodyResponseCallback + ): void; + accessSqlQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery + | 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$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Sessions$Create; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery; options = {}; } @@ -5071,82 +6397,92 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+name}:accessSqlQuery').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 the interactive session resource. If the session is not in terminal state, it is terminated, and then deleted. + * Obtain data corresponding to a spark stage attempt for a Spark Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Sessions$Delete, + accessStageAttempt( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Sessions$Delete, + accessStageAttempt( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Sessions$Delete, + ): GaxiosPromise; + accessStageAttempt( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + accessStageAttempt( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Sessions$Delete, - callback: BodyResponseCallback + accessStageAttempt( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + accessStageAttempt( + callback: BodyResponseCallback + ): void; + accessStageAttempt( paramsOrCallback?: - | Params$Resource$Projects$Locations$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt + | 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$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Sessions$Delete; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt; options = {}; } @@ -5159,8 +6495,11 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:accessStageAttempt').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -5171,67 +6510,77 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the resource representation for an interactive session. + * Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Sessions$Get, + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Sessions$Get, + accessStageRddGraph( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Sessions$Get, + ): GaxiosPromise; + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Sessions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Sessions$Get, - callback: BodyResponseCallback + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + accessStageRddGraph( + callback: BodyResponseCallback + ): void; + accessStageRddGraph( paramsOrCallback?: - | Params$Resource$Projects$Locations$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph + | 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$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Sessions$Get; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph; options = {}; } @@ -5244,7 +6593,10 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:accessStageRddGraph').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -5256,72 +6608,77 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists interactive sessions. + * Obtain high level information and list of Spark Applications corresponding to a batch * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Sessions$List, + search( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Search, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Sessions$List, + search( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Search, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Sessions$List, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Sessions$List, + search( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Sessions$List, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Search, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + search( + callback: BodyResponseCallback + ): void; + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Sessions$List; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Sessions$List; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Search; options = {}; } @@ -5334,7 +6691,7 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/sparkApplications:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -5349,67 +6706,77 @@ export namespace dataproc_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Terminates the interactive session. + * Obtain data corresponding to executors for a Spark Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - terminate( - params: Params$Resource$Projects$Locations$Sessions$Terminate, + searchExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors, options: StreamMethodOptions ): GaxiosPromise; - terminate( - params?: Params$Resource$Projects$Locations$Sessions$Terminate, + searchExecutors( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors, options?: MethodOptions - ): GaxiosPromise; - terminate( - params: Params$Resource$Projects$Locations$Sessions$Terminate, + ): GaxiosPromise; + searchExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - terminate( - params: Params$Resource$Projects$Locations$Sessions$Terminate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + searchExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - terminate( - params: Params$Resource$Projects$Locations$Sessions$Terminate, - callback: BodyResponseCallback + searchExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors, + callback: BodyResponseCallback ): void; - terminate(callback: BodyResponseCallback): void; - terminate( + searchExecutors( + callback: BodyResponseCallback + ): void; + searchExecutors( paramsOrCallback?: - | Params$Resource$Projects$Locations$Sessions$Terminate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors + | 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$Sessions$Terminate; + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Sessions$Terminate; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors; options = {}; } @@ -5422,11 +6789,11 @@ export namespace dataproc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:terminate').replace( + url: (rootUrl + '/v1/{+name}:searchExecutors').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -5437,84 +6804,4770 @@ export namespace dataproc_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$Sessions$Create - extends StandardParameters { /** - * Required. The parent resource where this session will be created. - */ - parent?: string; - /** - * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. - */ - requestId?: string; - /** - * Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/. + * Obtain executor summary with respect to a spark stage attempt. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - sessionId?: string; - + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary, + options: StreamMethodOptions + ): GaxiosPromise; + searchExecutorStageSummary( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary, + options?: MethodOptions + ): GaxiosPromise; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchExecutorStageSummary').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 + ); + } + } + + /** + * Obtain list of spark jobs corresponding to a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs, + options: StreamMethodOptions + ): GaxiosPromise; + searchJobs( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs, + options?: MethodOptions + ): GaxiosPromise; + searchJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs, + callback: BodyResponseCallback + ): void; + searchJobs( + callback: BodyResponseCallback + ): void; + searchJobs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchJobs').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 + ); + } + } + + /** + * Obtain data corresponding to SQL Queries for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchSqlQueries( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries, + options: StreamMethodOptions + ): GaxiosPromise; + searchSqlQueries( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries, + options?: MethodOptions + ): GaxiosPromise; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + callback: BodyResponseCallback + ): void; + searchSqlQueries( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchSqlQueries').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 + ); + } + } + + /** + * Obtain data corresponding to a spark stage attempts for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStageAttempts( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts, + options: StreamMethodOptions + ): GaxiosPromise; + searchStageAttempts( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts, + options?: MethodOptions + ): GaxiosPromise; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + callback: BodyResponseCallback + ): void; + searchStageAttempts( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStageAttempts').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 + ); + } + } + + /** + * Obtain data corresponding to tasks for a spark stage attempt for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks, + options: StreamMethodOptions + ): GaxiosPromise; + searchStageAttemptTasks( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks, + options?: MethodOptions + ): GaxiosPromise; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStageAttemptTasks').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 + ); + } + } + + /** + * Obtain data corresponding to stages for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages, + options: StreamMethodOptions + ): GaxiosPromise; + searchStages( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages, + options?: MethodOptions + ): GaxiosPromise; + searchStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages, + callback: BodyResponseCallback + ): void; + searchStages( + callback: BodyResponseCallback + ): void; + searchStages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStages').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 + ); + } + } + + /** + * Obtain summary of Executor Summary for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeExecutors( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors, + options?: MethodOptions + ): GaxiosPromise; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + callback: BodyResponseCallback + ): void; + summarizeExecutors( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeExecutors').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 + ); + } + } + + /** + * Obtain summary of Jobs for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeJobs( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs, + options?: MethodOptions + ): GaxiosPromise; + summarizeJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeJobs( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs, + callback: BodyResponseCallback + ): void; + summarizeJobs( + callback: BodyResponseCallback + ): void; + summarizeJobs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeJobs').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 + ); + } + } + + /** + * Obtain summary of Tasks for a Spark Application Stage Attempt + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeStageAttemptTasks( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks, + options?: MethodOptions + ): GaxiosPromise; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeStageAttemptTasks').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 + ); + } + } + + /** + * Obtain summary of Stages for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeStages( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages, + options?: MethodOptions + ): GaxiosPromise; + summarizeStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStages( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages, + callback: BodyResponseCallback + ): void; + summarizeStages( + callback: BodyResponseCallback + ): void; + summarizeStages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeStages').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 + ); + } + } + + /** + * Write wrapper objects from dataplane to spanner + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + write( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Write, + options: StreamMethodOptions + ): GaxiosPromise; + write( + params?: Params$Resource$Projects$Locations$Batches$Sparkapplications$Write, + options?: MethodOptions + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Write, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Projects$Locations$Batches$Sparkapplications$Write, + callback: BodyResponseCallback + ): void; + write( + callback: BodyResponseCallback + ): void; + write( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batches$Sparkapplications$Write + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batches$Sparkapplications$Write; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Batches$Sparkapplications$Write; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:write').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$Batches$Sparkapplications$Access + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessenvironmentinfo + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessjob + extends StandardParameters { + /** + * Required. Job ID to fetch data for. + */ + jobId?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlplan + extends StandardParameters { + /** + * Required. Execution ID + */ + executionId?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accesssqlquery + extends StandardParameters { + /** + * Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide. + */ + details?: boolean; + /** + * Required. Execution ID + */ + executionId?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Optional. Enables/ disables physical plan description on demand + */ + planDescription?: boolean; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstageattempt + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Accessstagerddgraph + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Search + extends StandardParameters { + /** + * Optional. Search only applications in the chosen state. + */ + applicationStatus?: string; + /** + * Optional. Latest end timestamp to list. + */ + maxEndTime?: string; + /** + * Optional. Latest start timestamp to list. + */ + maxTime?: string; + /** + * Optional. Earliest end timestamp to list. + */ + minEndTime?: string; + /** + * Optional. Earliest start timestamp to list. + */ + minTime?: string; + /** + * Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSparkApplications call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID" + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutors + extends StandardParameters { + /** + * Optional. Filter to select whether active/ dead or all executors should be selected. + */ + executorStatus?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchexecutorstagesummary + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous AccessSparkApplicationExecutorsList call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchjobs + extends StandardParameters { + /** + * Optional. List only jobs in the specific state. + */ + jobStatus?: string; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSparkApplicationJobs call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchsqlqueries + extends StandardParameters { + /** + * Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide. + */ + details?: boolean; + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Optional. Enables/ disables physical plan description on demand + */ + planDescription?: boolean; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempts + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Required. Stage ID for which attempts are to be fetched + */ + stageId?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstageattempttasks + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous ListSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Optional. Sort the tasks by runtime. + */ + sortRuntime?: boolean; + /** + * Optional. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Optional. Stage ID + */ + stageId?: string; + /** + * Optional. List only tasks in the state. + */ + taskStatus?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Searchstages + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous FetchSparkApplicationStagesList call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Optional. List only stages in the given state. + */ + stageStatus?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizeexecutors + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizejobs + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestageattempttasks + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Summarizestages + extends StandardParameters { + /** + * Required. The fully qualified name of the batch to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Batch) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Batches$Sparkapplications$Write + extends StandardParameters { + /** + * Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/batches/BATCH_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WriteSparkApplicationContextRequest; + } + + 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://dataproc.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://dataproc.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://dataproc.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://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + 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$Sessions { + context: APIRequestContext; + sparkApplications: Resource$Projects$Locations$Sessions$Sparkapplications; + constructor(context: APIRequestContext) { + this.context = context; + this.sparkApplications = + new Resource$Projects$Locations$Sessions$Sparkapplications( + this.context + ); + } + + /** + * Create an interactive session asynchronously. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Sessions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Sessions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Sessions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sessions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Sessions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sessions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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 the interactive session resource. If the session is not in terminal state, it is terminated, and then 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$Sessions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Sessions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Sessions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Sessions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sessions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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 resource representation for an interactive 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. + */ + get( + params: Params$Resource$Projects$Locations$Sessions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Sessions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Sessions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sessions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Sessions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sessions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.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 interactive sessions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Sessions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Sessions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Sessions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sessions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Sessions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sessions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/sessions').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); + } + } + + /** + * Terminates the interactive 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. + */ + terminate( + params: Params$Resource$Projects$Locations$Sessions$Terminate, + options: StreamMethodOptions + ): GaxiosPromise; + terminate( + params?: Params$Resource$Projects$Locations$Sessions$Terminate, + options?: MethodOptions + ): GaxiosPromise; + terminate( + params: Params$Resource$Projects$Locations$Sessions$Terminate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + terminate( + params: Params$Resource$Projects$Locations$Sessions$Terminate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + terminate( + params: Params$Resource$Projects$Locations$Sessions$Terminate, + callback: BodyResponseCallback + ): void; + terminate(callback: BodyResponseCallback): void; + terminate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Terminate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Terminate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Sessions$Terminate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:terminate').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$Sessions$Create + extends StandardParameters { + /** + * Required. The parent resource where this session will be created. + */ + parent?: string; + /** + * Optional. A unique ID used to identify the request. If the service receives two CreateSessionRequests (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateSessionRequest)s with the same ID, the second request is ignored, and the first Session is created and stored in the backend.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string; + /** + * Required. The ID to use for the session, which becomes the final component of the session's resource name.This value must be 4-63 characters. Valid characters are /a-z-/. + */ + sessionId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Session; + } + export interface Params$Resource$Projects$Locations$Sessions$Delete + extends StandardParameters { + /** + * Required. The name of the session resource to delete. + */ + name?: string; + /** + * Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Get + extends StandardParameters { + /** + * Required. The name of the session to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$List + extends StandardParameters { + /** + * Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators. + */ + filter?: string; + /** + * Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of sessions. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Terminate + extends StandardParameters { + /** + * Required. The name of the session resource to terminate. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TerminateSessionRequest; + } + + export class Resource$Projects$Locations$Sessions$Sparkapplications { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Obtain high level information corresponding to a single Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + access( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access, + options: StreamMethodOptions + ): GaxiosPromise; + access( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access, + options?: MethodOptions + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access, + callback: BodyResponseCallback + ): void; + access( + callback: BodyResponseCallback + ): void; + access( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Access; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:access').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 + ); + } + } + + /** + * Obtain environment details for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo, + options: StreamMethodOptions + ): GaxiosPromise; + accessEnvironmentInfo( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo, + options?: MethodOptions + ): GaxiosPromise; + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessEnvironmentInfo( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo, + callback: BodyResponseCallback + ): void; + accessEnvironmentInfo( + callback: BodyResponseCallback + ): void; + accessEnvironmentInfo( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessEnvironmentInfo').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 + ); + } + } + + /** + * Obtain data corresponding to a spark job for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessJob( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob, + options: StreamMethodOptions + ): GaxiosPromise; + accessJob( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob, + options?: MethodOptions + ): GaxiosPromise; + accessJob( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessJob( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessJob( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob, + callback: BodyResponseCallback + ): void; + accessJob( + callback: BodyResponseCallback + ): void; + accessJob( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessJob').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 + ); + } + } + + /** + * Obtain Spark Plan Graph for a Spark Application SQL execution. Limits the number of clusters returned as part of the graph to 10000. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessSqlPlan( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan, + options: StreamMethodOptions + ): GaxiosPromise; + accessSqlPlan( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan, + options?: MethodOptions + ): GaxiosPromise; + accessSqlPlan( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessSqlPlan( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessSqlPlan( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan, + callback: BodyResponseCallback + ): void; + accessSqlPlan( + callback: BodyResponseCallback + ): void; + accessSqlPlan( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessSqlPlan').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 + ); + } + } + + /** + * Obtain data corresponding to a particular SQL Query for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessSqlQuery( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery, + options: StreamMethodOptions + ): GaxiosPromise; + accessSqlQuery( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery, + options?: MethodOptions + ): GaxiosPromise; + accessSqlQuery( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessSqlQuery( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessSqlQuery( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery, + callback: BodyResponseCallback + ): void; + accessSqlQuery( + callback: BodyResponseCallback + ): void; + accessSqlQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessSqlQuery').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 + ); + } + } + + /** + * Obtain data corresponding to a spark stage attempt for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessStageAttempt( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt, + options: StreamMethodOptions + ): GaxiosPromise; + accessStageAttempt( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt, + options?: MethodOptions + ): GaxiosPromise; + accessStageAttempt( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessStageAttempt( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessStageAttempt( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt, + callback: BodyResponseCallback + ): void; + accessStageAttempt( + callback: BodyResponseCallback + ): void; + accessStageAttempt( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessStageAttempt').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 + ); + } + } + + /** + * Obtain RDD operation graph for a Spark Application Stage. Limits the number of clusters returned as part of the graph to 10000. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph, + options: StreamMethodOptions + ): GaxiosPromise; + accessStageRddGraph( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph, + options?: MethodOptions + ): GaxiosPromise; + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accessStageRddGraph( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph, + callback: BodyResponseCallback + ): void; + accessStageRddGraph( + callback: BodyResponseCallback + ): void; + accessStageRddGraph( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:accessStageRddGraph').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 + ); + } + } + + /** + * Obtain high level information and list of Spark Applications corresponding to 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. + */ + search( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/sparkApplications:search').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 + ); + } + } + + /** + * Obtain data corresponding to executors for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors, + options: StreamMethodOptions + ): GaxiosPromise; + searchExecutors( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors, + options?: MethodOptions + ): GaxiosPromise; + searchExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors, + callback: BodyResponseCallback + ): void; + searchExecutors( + callback: BodyResponseCallback + ): void; + searchExecutors( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchExecutors').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 + ); + } + } + + /** + * Obtain executor summary with respect to a spark stage attempt. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary, + options: StreamMethodOptions + ): GaxiosPromise; + searchExecutorStageSummary( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary, + options?: MethodOptions + ): GaxiosPromise; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary, + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + callback: BodyResponseCallback + ): void; + searchExecutorStageSummary( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchExecutorStageSummary').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 + ); + } + } + + /** + * Obtain list of spark jobs corresponding to a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs, + options: StreamMethodOptions + ): GaxiosPromise; + searchJobs( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs, + options?: MethodOptions + ): GaxiosPromise; + searchJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs, + callback: BodyResponseCallback + ): void; + searchJobs( + callback: BodyResponseCallback + ): void; + searchJobs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchJobs').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 + ); + } + } + + /** + * Obtain data corresponding to SQL Queries for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchSqlQueries( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries, + options: StreamMethodOptions + ): GaxiosPromise; + searchSqlQueries( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries, + options?: MethodOptions + ): GaxiosPromise; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries, + callback: BodyResponseCallback + ): void; + searchSqlQueries( + callback: BodyResponseCallback + ): void; + searchSqlQueries( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchSqlQueries').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 + ); + } + } + + /** + * Obtain data corresponding to a spark stage attempts for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStageAttempts( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts, + options: StreamMethodOptions + ): GaxiosPromise; + searchStageAttempts( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts, + options?: MethodOptions + ): GaxiosPromise; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts, + callback: BodyResponseCallback + ): void; + searchStageAttempts( + callback: BodyResponseCallback + ): void; + searchStageAttempts( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStageAttempts').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 + ); + } + } + + /** + * Obtain data corresponding to tasks for a spark stage attempt for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks, + options: StreamMethodOptions + ): GaxiosPromise; + searchStageAttemptTasks( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks, + options?: MethodOptions + ): GaxiosPromise; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks, + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + callback: BodyResponseCallback + ): void; + searchStageAttemptTasks( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStageAttemptTasks').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 + ); + } + } + + /** + * Obtain data corresponding to stages for a Spark Application. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages, + options: StreamMethodOptions + ): GaxiosPromise; + searchStages( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages, + options?: MethodOptions + ): GaxiosPromise; + searchStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages, + callback: BodyResponseCallback + ): void; + searchStages( + callback: BodyResponseCallback + ): void; + searchStages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:searchStages').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 + ); + } + } + + /** + * Obtain summary of Executor Summary for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeExecutors( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors, + options?: MethodOptions + ): GaxiosPromise; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors, + callback: BodyResponseCallback + ): void; + summarizeExecutors( + callback: BodyResponseCallback + ): void; + summarizeExecutors( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeExecutors').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 + ); + } + } + + /** + * Obtain summary of Jobs for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeJobs( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs, + options?: MethodOptions + ): GaxiosPromise; + summarizeJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeJobs( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs, + callback: BodyResponseCallback + ): void; + summarizeJobs( + callback: BodyResponseCallback + ): void; + summarizeJobs( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeJobs').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 + ); + } + } + + /** + * Obtain summary of Tasks for a Spark Application Stage Attempt + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeStageAttemptTasks( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks, + options?: MethodOptions + ): GaxiosPromise; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks, + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + callback: BodyResponseCallback + ): void; + summarizeStageAttemptTasks( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeStageAttemptTasks').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 + ); + } + } + + /** + * Obtain summary of Stages for a Spark Application + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + summarizeStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages, + options: StreamMethodOptions + ): GaxiosPromise; + summarizeStages( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages, + options?: MethodOptions + ): GaxiosPromise; + summarizeStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + summarizeStages( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages, + callback: BodyResponseCallback + ): void; + summarizeStages( + callback: BodyResponseCallback + ): void; + summarizeStages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:summarizeStages').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 + ); + } + } + + /** + * Write wrapper objects from dataplane to spanner + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + write( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write, + options: StreamMethodOptions + ): GaxiosPromise; + write( + params?: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write, + options?: MethodOptions + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write, + callback: BodyResponseCallback + ): void; + write( + callback: BodyResponseCallback + ): void; + write( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataproc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:write').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$Sessions$Sparkapplications$Access + extends StandardParameters { /** - * Request body metadata + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" */ - requestBody?: Schema$Session; + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Sessions$Delete + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessenvironmentinfo extends StandardParameters { /** - * Required. The name of the session resource to delete. + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" */ name?: string; /** - * Optional. A unique ID used to identify the request. If the service receives two DeleteSessionRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.DeleteSessionRequest)s with the same ID, the second request is ignored.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The value must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. + * Required. Parent (Session) resource reference. */ - requestId?: string; + parent?: string; } - export interface Params$Resource$Projects$Locations$Sessions$Get + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessjob extends StandardParameters { /** - * Required. The name of the session to retrieve. + * Required. Job ID to fetch data for. + */ + jobId?: string; + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" */ name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Sessions$List + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlplan extends StandardParameters { /** - * Optional. A filter for the sessions to return in the response.A filter is a logical expression constraining the values of various fields in each session resource. Filters are case sensitive, and may contain multiple clauses combined with logical operators (AND, OR). Supported fields are session_id, session_uuid, state, create_time, and labels.Example: state = ACTIVE and create_time < "2023-01-01T00:00:00Z" is a filter for sessions in an ACTIVE state that were created before 2023-01-01. state = ACTIVE and labels.environment=production is a filter for sessions in an ACTIVE state that have a production environment label.See https://google.aip.dev/assets/misc/ebnf-filtering.txt for a detailed description of the filter syntax and a list of supported comparators. + * Required. Execution ID */ - filter?: string; + executionId?: string; /** - * Optional. The maximum number of sessions to return in each response. The service may return fewer than this value. + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accesssqlquery + extends StandardParameters { + /** + * Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide. + */ + details?: boolean; + /** + * Required. Execution ID + */ + executionId?: string; + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Optional. Enables/ disables physical plan description on demand + */ + planDescription?: boolean; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstageattempt + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Accessstagerddgraph + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Search + extends StandardParameters { + /** + * Optional. Search only applications in the chosen state. + */ + applicationStatus?: string; + /** + * Optional. Latest end timestamp to list. + */ + maxEndTime?: string; + /** + * Optional. Latest start timestamp to list. + */ + maxTime?: string; + /** + * Optional. Earliest end timestamp to list. + */ + minEndTime?: string; + /** + * Optional. Earliest start timestamp to list. + */ + minTime?: string; + /** + * Optional. Maximum number of applications to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. */ pageSize?: number; /** - * Optional. A page token received from a previous ListSessions call. Provide this token to retrieve the subsequent page. + * Optional. A page token received from a previous SearchSessionSparkApplications call. Provide this token to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent, which owns this collection of sessions. + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID" */ parent?: string; } - export interface Params$Resource$Projects$Locations$Sessions$Terminate + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutors extends StandardParameters { /** - * Required. The name of the session resource to terminate. + * Optional. Filter to select whether active/ dead or all executors should be selected. + */ + executorStatus?: string; + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationExecutors call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchexecutorstagesummary + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of executors to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationExecutorStageSummary call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchjobs + extends StandardParameters { + /** + * Optional. List only jobs in the specific state. + */ + jobStatus?: string; + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of jobs to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationJobs call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchsqlqueries + extends StandardParameters { + /** + * Optional. Lists/ hides details of Spark plan nodes. True is set to list and false to hide. + */ + details?: boolean; + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of queries to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationSqlQueries call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Optional. Enables/ disables physical plan description on demand + */ + planDescription?: boolean; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempts + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of stage attempts (paging based on stage_attempt_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationStageAttempts call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Required. Stage ID for which attempts are to be fetched + */ + stageId?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstageattempttasks + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of tasks to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationStageAttemptTasks call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Optional. Sort the tasks by runtime. + */ + sortRuntime?: boolean; + /** + * Optional. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Optional. Stage ID + */ + stageId?: string; + /** + * Optional. List only tasks in the state. + */ + taskStatus?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Searchstages + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Optional. Maximum number of stages (paging based on stage_id) to return in each response. The service may return fewer than this. The default page size is 10; the maximum page size is 100. + */ + pageSize?: number; + /** + * Optional. A page token received from a previous SearchSessionSparkApplicationStages call. Provide this token to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Optional. List only stages in the given state. + */ + stageStatus?: string; + /** + * Optional. The list of summary metrics fields to include. Empty list will default to skip all summary metrics fields. Example, if the response should include TaskQuantileMetrics, the request should have task_quantile_metrics in summary_metrics_mask field + */ + summaryMetricsMask?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizeexecutors + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizejobs + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestageattempttasks + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + /** + * Required. Stage Attempt ID + */ + stageAttemptId?: number; + /** + * Required. Stage ID + */ + stageId?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Summarizestages + extends StandardParameters { + /** + * Required. The fully qualified name of the session to retrieve in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" + */ + name?: string; + /** + * Required. Parent (Session) resource reference. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Sessions$Sparkapplications$Write + extends StandardParameters { + /** + * Required. The fully qualified name of the spark application to write data about in the format "projects/PROJECT_ID/locations/DATAPROC_REGION/sessions/SESSION_ID/sparkApplications/APPLICATION_ID" */ name?: string; /** * Request body metadata */ - requestBody?: Schema$TerminateSessionRequest; + requestBody?: Schema$WriteSessionSparkApplicationContextRequest; } export class Resource$Projects$Locations$Sessiontemplates { diff --git a/src/apis/datastream/v1.ts b/src/apis/datastream/v1.ts index c85637874e..65b411b8a0 100644 --- a/src/apis/datastream/v1.ts +++ b/src/apis/datastream/v1.ts @@ -1294,6 +1294,10 @@ export namespace datastream_v1 { * Optional. The CDC strategy of the stream. If not set, the system's default value will be used. */ cdcStrategy?: Schema$CdcStrategy; + /** + * Optional. Update the stream without validating it. + */ + force?: boolean | null; } /** * A single target dataset to which all data will be streamed. diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index 0c565a29c3..04ac87eac6 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -140,6 +140,10 @@ export namespace developerconnect_v1 { * Output only. [Output only] Create timestamp */ createTime?: string | null; + /** + * Optional. The crypto key configuration. This field is used by the Customer-Managed Encryption Keys (CMEK) feature. + */ + cryptoKeyConfig?: Schema$CryptoKeyConfig; /** * Output only. [Output only] Delete timestamp */ @@ -156,6 +160,18 @@ export namespace developerconnect_v1 { * Configuration for connections to github.com. */ githubConfig?: Schema$GitHubConfig; + /** + * Configuration for connections to an instance of GitHub Enterprise. + */ + githubEnterpriseConfig?: Schema$GitHubEnterpriseConfig; + /** + * Configuration for connections to gitlab.com. + */ + gitlabConfig?: Schema$GitLabConfig; + /** + * Configuration for connections to an instance of GitLab Enterprise. + */ + gitlabEnterpriseConfig?: Schema$GitLabEnterpriseConfig; /** * Output only. Installation state of the Connection. */ @@ -181,6 +197,15 @@ export namespace developerconnect_v1 { */ updateTime?: string | null; } + /** + * The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. + */ + export interface Schema$CryptoKeyConfig { + /** + * Required. The name of the key which is used to encrypt/decrypt customer data. For key in Cloud KMS, the key should be in the format of `projects/x/locations/x/keyRings/x/cryptoKeys/x`. + */ + keyReference?: 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); \} */ @@ -283,6 +308,101 @@ export namespace developerconnect_v1 { */ installationUri?: string | null; } + /** + * Configuration for connections to an instance of GitHub Enterprise. + */ + export interface Schema$GitHubEnterpriseConfig { + /** + * Optional. ID of the GitHub App created from the manifest. + */ + appId?: string | null; + /** + * Optional. ID of the installation of the GitHub App. + */ + appInstallationId?: string | null; + /** + * Output only. The URL-friendly name of the GitHub App. + */ + appSlug?: string | null; + /** + * Required. The URI of the GitHub Enterprise host this connection is for. + */ + hostUri?: string | null; + /** + * Output only. The URI to navigate to in order to manage the installation associated with this GitHubEnterpriseConfig. + */ + installationUri?: string | null; + /** + * Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/x/secrets/x/versions/x`. + */ + privateKeySecretVersion?: string | null; + /** + * Output only. GitHub Enterprise version installed at the host_uri. + */ + serverVersion?: string | null; + /** + * Optional. Configuration for using Service Directory to privately connect to a GitHub Enterprise server. This should only be set if the GitHub Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitHub Enterprise server will be made over the public internet. + */ + serviceDirectoryConfig?: Schema$ServiceDirectoryConfig; + /** + * Optional. SSL certificate to use for requests to GitHub Enterprise. + */ + sslCaCertificate?: string | null; + /** + * Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/x/secrets/x/versions/x`. + */ + webhookSecretSecretVersion?: string | null; + } + /** + * Configuration for connections to gitlab.com. + */ + export interface Schema$GitLabConfig { + /** + * Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to. + */ + authorizerCredential?: Schema$UserCredential; + /** + * Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to. + */ + readAuthorizerCredential?: Schema$UserCredential; + /** + * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + */ + webhookSecretSecretVersion?: string | null; + } + /** + * Configuration for connections to an instance of GitLab Enterprise. + */ + export interface Schema$GitLabEnterpriseConfig { + /** + * Required. A GitLab personal access token with the minimum `api` scope access and a minimum role of `maintainer`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to. + */ + authorizerCredential?: Schema$UserCredential; + /** + * Required. The URI of the GitLab Enterprise host this connection is for. + */ + hostUri?: string | null; + /** + * Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to. + */ + readAuthorizerCredential?: Schema$UserCredential; + /** + * Output only. Version of the GitLab Enterprise server running on the `host_uri`. + */ + serverVersion?: string | null; + /** + * Optional. Configuration for using Service Directory to privately connect to a GitLab Enterprise instance. This should only be set if the GitLab Enterprise server is hosted on-premises and not reachable by public internet. If this field is left empty, calls to the GitLab Enterprise server will be made over the public internet. + */ + serviceDirectoryConfig?: Schema$ServiceDirectoryConfig; + /** + * Optional. SSL Certificate Authority certificate to use for requests to GitLab Enterprise instance. + */ + sslCaCertificate?: string | null; + /** + * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + */ + webhookSecretSecretVersion?: string | null; + } /** * Message describing the GitRepositoryLink object */ @@ -327,6 +447,10 @@ export namespace developerconnect_v1 { * Output only. [Output only] Update timestamp */ updateTime?: string | null; + /** + * Output only. External ID of the webhook created for the repository. + */ + webhookId?: string | null; } /** * Represents an installation of the GitHub App. @@ -527,6 +651,15 @@ export namespace developerconnect_v1 { */ verb?: string | null; } + /** + * ServiceDirectoryConfig represents Service Directory configuration for a connection. + */ + export interface Schema$ServiceDirectoryConfig { + /** + * Required. The Service Directory service name. Format: projects/{project\}/locations/{location\}/namespaces/{namespace\}/services/{service\}. + */ + service?: 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). */ @@ -544,6 +677,19 @@ export namespace developerconnect_v1 { */ message?: string | null; } + /** + * Represents a personal access token that authorized the Connection, and associated metadata. + */ + export interface Schema$UserCredential { + /** + * Output only. The username associated with this token. + */ + username?: string | null; + /** + * Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/x/secrets/x/versions/x`. + */ + userTokenSecretVersion?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1535,7 +1681,7 @@ export namespace developerconnect_v1 { */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the Connection 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. Required. Field mask is used to specify the fields to be overwritten in the Connection 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; /** diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 7095cc84f5..2fb3500236 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -170,6 +170,8 @@ export namespace dfareporting_v4 { subaccounts: Resource$Subaccounts; targetableRemarketingLists: Resource$Targetableremarketinglists; targetingTemplates: Resource$Targetingtemplates; + tvCampaignDetails: Resource$Tvcampaigndetails; + tvCampaignSummaries: Resource$Tvcampaignsummaries; userProfiles: Resource$Userprofiles; userRolePermissionGroups: Resource$Userrolepermissiongroups; userRolePermissions: Resource$Userrolepermissions; @@ -261,6 +263,8 @@ export namespace dfareporting_v4 { this.context ); this.targetingTemplates = new Resource$Targetingtemplates(this.context); + this.tvCampaignDetails = new Resource$Tvcampaigndetails(this.context); + this.tvCampaignSummaries = new Resource$Tvcampaignsummaries(this.context); this.userProfiles = new Resource$Userprofiles(this.context); this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( this.context @@ -1382,7 +1386,7 @@ export namespace dfareporting_v4 { totalAmountMicros?: string | null; } /** - * Contains additional information about cart data. + * Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. */ export interface Schema$CartData { /** @@ -1398,7 +1402,7 @@ export namespace dfareporting_v4 { */ merchantFeedLanguage?: string | null; /** - * The Merchant Center ID where the items are uploaded. + * The Merchant Center ID where the items are uploaded. This is a required field. */ merchantId?: string | null; } @@ -1634,13 +1638,17 @@ export namespace dfareporting_v4 { kind?: string | null; } /** - * Represents a response to the queryCompatibleFields method. + * Represents a response to the queryCompatibleFields method. Next ID: 10 */ export interface Schema$CompatibleFields { /** * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachReportCompatibleFields?: Schema$CrossMediaReachReportCompatibleFields; /** * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */ @@ -1744,7 +1752,7 @@ export namespace dfareporting_v4 { */ childDirectedTreatment?: boolean | null; /** - * Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. + * Custom floodlight variables. */ customVariables?: Schema$CustomFloodlightVariable[]; /** @@ -2866,6 +2874,27 @@ export namespace dfareporting_v4 { */ overlapMetrics?: Schema$Metric[]; } + /** + * Represents fields that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + export interface Schema$CrossMediaReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } /** * A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. */ @@ -2875,7 +2904,7 @@ export namespace dfareporting_v4 { */ kind?: string | null; /** - * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. + * The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags. */ type?: string | null; /** @@ -5739,6 +5768,15 @@ export namespace dfareporting_v4 { overlapMetricNames?: string[]; pivoted?: boolean; } | null; + /** + * Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachCriteria?: { + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + } | null; /** * The report's email delivery settings. */ @@ -6590,6 +6628,94 @@ export namespace dfareporting_v4 { */ kind?: string | null; } + /** + * TvCampaignDetail contains data from a TV campaign for specific start dates and date windows. + */ + export interface Schema$TvCampaignDetail { + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * The timepoints of the TV campaign. + */ + timepoints?: Schema$TvCampaignTimepoint[]; + } + /** + * Response message for TvCampaignSummariesService.List. + */ + export interface Schema$TvCampaignSummariesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummariesListResponse". + */ + kind?: string | null; + /** + * List of TV campaign summaries. + */ + tvCampaignSummaries?: Schema$TvCampaignSummary[]; + } + /** + * TvCampaignSummary contains aggregate data from a TV campaign. + */ + export interface Schema$TvCampaignSummary { + /** + * The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + endDate?: string | null; + /** + * GRP of this TV campaign. + */ + grp?: string | null; + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Impressions across the entire TV campaign. + */ + impressions?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * Identifier. Name of this TV campaign. + */ + name?: string | null; + /** + * Spend across the entire TV campaign. + */ + spend?: number | null; + /** + * The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + startDate?: string | null; + /** + * "CampaignComponentType" of this TV campaign. + */ + type?: string | null; + } + /** + * A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window. + */ + export interface Schema$TvCampaignTimepoint { + /** + * The date window of the timepoint. + */ + dateWindow?: string | null; + /** + * The spend within the time range of the timepoint. + */ + spend?: number | null; + /** + * The start date of the timepoint. A string in the format of "yyyy-MM-dd". + */ + startDate?: string | null; + } /** * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. */ @@ -28467,6 +28593,237 @@ export namespace dfareporting_v4 { requestBody?: Schema$TargetingTemplate; } + export class Resource$Tvcampaigndetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one TvCampaignDetail by ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Tvcampaigndetails$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Tvcampaigndetails$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaigndetails$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaigndetails$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v4/userprofiles/{+profileId}/tvCampaignDetails/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Tvcampaigndetails$Get + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. TV Campaign ID. + */ + id?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Tvcampaignsummaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of TV campaign summaries. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Tvcampaignsummaries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Tvcampaignsummaries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaignsummaries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaignsummaries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v4/userprofiles/{+profileId}/tvCampaignSummaries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Tvcampaignsummaries$List + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. + */ + name?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + export class Resource$Userprofiles { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 6bdd4692e7..03f5f1d73c 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -6029,6 +6029,14 @@ export namespace dialogflow_v2 { * Output only. ConversationDataset resource name. Format: `projects//locations//conversationDatasets/` */ name?: string | null; + /** + * Output only. A read only boolean field reflecting Zone Isolation status of the dataset. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. A read only boolean field reflecting Zone Separation status of the dataset. + */ + satisfiesPzs?: boolean | null; } /** * Represents a notification sent to Pub/Sub subscribers for conversation lifecycle events. @@ -6088,6 +6096,14 @@ export namespace dialogflow_v2 { * ConversationModel resource name. Format: `projects//conversationModels/` */ name?: string | null; + /** + * Output only. A read only boolean field reflecting Zone Isolation status of the model. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. A read only boolean field reflecting Zone Separation status of the model. + */ + satisfiesPzs?: boolean | null; /** * Metadata for smart reply models. */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index a0419053b8..5e2f2b9953 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -8141,6 +8141,14 @@ export namespace dialogflow_v2beta1 { * ConversationModel resource name. Format: `projects//conversationModels/` */ name?: string | null; + /** + * Output only. A read only boolean field reflecting Zone Isolation status of the model. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. A read only boolean field reflecting Zone Separation status of the model. + */ + satisfiesPzs?: boolean | null; /** * Metadata for smart reply models. */ diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index b81e4ce6d4..d7e7537b6b 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -4450,7 +4450,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3NluSettings { /** - * To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + * To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. */ classificationThreshold?: number | null; /** @@ -4695,7 +4695,7 @@ export namespace dialogflow_v3 { */ currentPage?: Schema$GoogleCloudDialogflowCxV3Page; /** - * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request. */ dataStoreConnectionSignals?: Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignals; /** @@ -7995,6 +7995,14 @@ export namespace dialogflow_v3 { * ConversationModel resource name. Format: `projects//conversationModels/` */ name?: string | null; + /** + * Output only. A read only boolean field reflecting Zone Isolation status of the model. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. A read only boolean field reflecting Zone Separation status of the model. + */ + satisfiesPzs?: boolean | null; /** * Metadata for smart reply models. */ diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 827564e575..5320b269e4 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -377,6 +377,10 @@ export namespace dialogflow_v3beta1 { * The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. */ avatarUri?: string | null; + /** + * Optional. The BigQuery export settings for this agent. The conversation data will be exported to BigQuery tables if it is enabled. By default, BigQuery export settings will not be exported with agent. You need to set include_bigquery_export_settings to include it in the exported agent. + */ + bigqueryExportSettings?: Schema$GoogleCloudDialogflowCxV3beta1BigQueryExportSettings; /** * Optional. Settings for custom client certificates. */ @@ -650,6 +654,19 @@ export namespace dialogflow_v3beta1 { */ results?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult[]; } + /** + * The settings of BigQuery export. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1BigQueryExportSettings { + /** + * The BigQuery table to export. Format: `projects//datasets//tables/`. + */ + bigqueryTable?: string | null; + /** + * The field to indicate whether the BigQuery export is enabled. + */ + enabled?: boolean | null; + } /** * Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec */ @@ -1602,7 +1619,7 @@ export namespace dialogflow_v3beta1 { */ 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. + * 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; /** @@ -3258,7 +3275,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1NluSettings { /** - * To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. + * To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a no-match event will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. You can set a separate classification threshold for the flow in each language enabled for the agent. */ classificationThreshold?: number | null; /** @@ -3691,7 +3708,7 @@ export namespace dialogflow_v3beta1 { */ currentPage?: Schema$GoogleCloudDialogflowCxV3beta1Page; /** - * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. + * Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate_data_store_connection_signals is set to true in the request. */ dataStoreConnectionSignals?: Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignals; /** @@ -4078,6 +4095,10 @@ export namespace dialogflow_v3beta1 { * Banned phrases for generated text. */ bannedPhrases?: Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsPhrase[]; + /** + * Optional. Default phrase match strategy for banned phrases. + */ + defaultBannedPhraseMatchStrategy?: string | null; } /** * Text input which can be used for prompt or banned phrases. @@ -4534,6 +4555,10 @@ export namespace dialogflow_v3beta1 { * Required. OAuth grant types. */ oauthGrantType?: string | null; + /** + * Optional. The OAuth scopes to grant. + */ + scopes?: string[] | null; /** * Required. The token endpoint in the OAuth provider to exchange for an access token. */ @@ -8905,6 +8930,14 @@ export namespace dialogflow_v3beta1 { * ConversationModel resource name. Format: `projects//conversationModels/` */ name?: string | null; + /** + * Output only. A read only boolean field reflecting Zone Isolation status of the model. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. A read only boolean field reflecting Zone Separation status of the model. + */ + satisfiesPzs?: boolean | null; /** * Metadata for smart reply models. */ @@ -21648,7 +21681,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Playbooks$Examples$List extends StandardParameters { /** - * Optional. The language to list examples for. If not specified, the agent's default language is used. Note: languages must be enabled in the agent before they can be used. + * 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; /** diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index 8c96ec3acb..f19aeafae8 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -553,7 +553,7 @@ export namespace discoveryengine_v1 { */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */ structData?: {[key: string]: any} | null; /** @@ -835,6 +835,10 @@ export namespace discoveryengine_v1 { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -848,7 +852,7 @@ export namespace discoveryengine_v1 { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -864,6 +868,10 @@ export namespace discoveryengine_v1 { * 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; + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -900,6 +908,14 @@ export namespace discoveryengine_v1 { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -913,6 +929,35 @@ export namespace discoveryengine_v1 { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -999,7 +1044,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -1108,6 +1153,10 @@ export namespace discoveryengine_v1 { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -1121,7 +1170,7 @@ export namespace discoveryengine_v1 { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -1382,6 +1431,10 @@ export namespace discoveryengine_v1 { * Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. */ keyPropertyType?: string | null; + /** + * Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + */ + metatagName?: string | null; /** * If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. */ @@ -1672,6 +1725,15 @@ export namespace discoveryengine_v1 { */ models?: Schema$GoogleCloudDiscoveryengineV1alphaCustomTuningModel[]; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -1681,7 +1743,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -2070,6 +2132,10 @@ export namespace discoveryengine_v1 { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -2275,6 +2341,10 @@ export namespace discoveryengine_v1 { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -2334,6 +2404,10 @@ export namespace discoveryengine_v1 { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -2433,6 +2507,15 @@ export namespace discoveryengine_v1 { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -2477,6 +2560,15 @@ export namespace discoveryengine_v1 { */ mode?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * External session proto definition. */ @@ -2655,7 +2747,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -2710,6 +2802,14 @@ export namespace discoveryengine_v1 { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -2799,7 +2899,7 @@ export namespace discoveryengine_v1 { */ answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec; /** - * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + * Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */ asynchronousMode?: boolean | null; /** @@ -2847,6 +2947,10 @@ export namespace discoveryengine_v1 { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */ @@ -3015,6 +3119,23 @@ export namespace discoveryengine_v1 { * Chunk textual content. */ content?: string | null; + /** + * Metadata of the document from the current chunk. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata; + } + /** + * Document metadata contains the information of the document of the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata { + /** + * Title of the document. + */ + title?: string | null; + /** + * Uri of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -3025,11 +3146,11 @@ export namespace discoveryengine_v1 { */ document?: string | null; /** - * List of document contexts. + * List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive. */ documentContexts?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; /** - * List of extractive answers. + * Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers. */ extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; /** @@ -3050,7 +3171,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { /** - * Document content. + * Document content to be used for answer generation. */ content?: string | null; /** @@ -3072,7 +3193,7 @@ export namespace discoveryengine_v1 { pageIdentifier?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets. */ export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { /** @@ -3298,7 +3419,7 @@ export namespace discoveryengine_v1 { */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */ structData?: {[key: string]: any} | null; /** @@ -3406,9 +3527,9 @@ export namespace discoveryengine_v1 { */ matcherValue?: Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; /** - * The status of the document. + * The state of the document. */ - status?: string | null; + state?: string | null; } /** * The value of the matcher that was used to match the Document. @@ -3649,6 +3770,10 @@ export namespace discoveryengine_v1 { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -3662,7 +3787,7 @@ export namespace discoveryengine_v1 { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -3674,6 +3799,10 @@ export namespace discoveryengine_v1 { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -3706,6 +3835,14 @@ export namespace discoveryengine_v1 { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -3719,6 +3856,35 @@ export namespace discoveryengine_v1 { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -3805,7 +3971,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -3914,6 +4080,10 @@ export namespace discoveryengine_v1 { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -3923,7 +4093,7 @@ export namespace discoveryengine_v1 { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -4305,6 +4475,15 @@ export namespace discoveryengine_v1 { */ models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -4314,7 +4493,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -4552,6 +4731,10 @@ export namespace discoveryengine_v1 { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -4757,6 +4940,10 @@ export namespace discoveryengine_v1 { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -4816,6 +5003,10 @@ export namespace discoveryengine_v1 { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -4915,6 +5106,15 @@ export namespace discoveryengine_v1 { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -4959,6 +5159,15 @@ export namespace discoveryengine_v1 { */ mode?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Verification information for target sites in advanced site search. */ @@ -5078,7 +5287,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -5133,6 +5342,14 @@ export namespace discoveryengine_v1 { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -5716,7 +5933,7 @@ export namespace discoveryengine_v1 { */ safeSearch?: boolean | null; /** - * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. + * The resource name of the Serving Config to use. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. */ servingConfig?: string | null; /** @@ -5835,6 +6052,10 @@ export namespace discoveryengine_v1 { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -5848,7 +6069,7 @@ export namespace discoveryengine_v1 { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -5860,6 +6081,10 @@ export namespace discoveryengine_v1 { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -5888,6 +6113,10 @@ export namespace discoveryengine_v1 { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -5901,6 +6130,35 @@ export namespace discoveryengine_v1 { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5990,6 +6248,10 @@ export namespace discoveryengine_v1 { * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ id?: string | null; + /** + * Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + */ + indexStatus?: Schema$GoogleCloudDiscoveryengineV1DocumentIndexStatus; /** * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */ @@ -6032,6 +6294,19 @@ export namespace discoveryengine_v1 { */ uri?: string | null; } + /** + * Index status of the document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentIndexStatus { + /** + * A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The time when the document was indexed. If this field is populated, it means the document has been indexed. + */ + indexTime?: string | null; + } /** * Detailed document information associated with a user event. */ @@ -6045,7 +6320,7 @@ export namespace discoveryengine_v1 { */ joined?: boolean | null; /** - * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` + * The Document resource full name, of the form: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` */ name?: string | null; /** @@ -6078,7 +6353,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -6191,6 +6466,10 @@ export namespace discoveryengine_v1 { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -6200,7 +6479,7 @@ export namespace discoveryengine_v1 { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -6890,7 +7169,7 @@ export namespace discoveryengine_v1 { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -7243,6 +7522,10 @@ export namespace discoveryengine_v1 { * Request message for SiteSearchEngineService.RecrawlUris method. */ export interface Schema$GoogleCloudDiscoveryengineV1RecrawlUrisRequest { + /** + * Optional. Full resource name of the SiteCredential, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + */ + siteCredential?: string | null; /** * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */ @@ -7409,11 +7692,49 @@ export namespace discoveryengine_v1 { * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ boost?: number | null; + /** + * Complex specification for custom ranking based on customer defined attribute value. + */ + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec; /** * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ condition?: string | null; } + /** + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec { + /** + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + */ + attributeType?: string | null; + /** + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + */ + controlPoints?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; + /** + * The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * The interpolation type to be applied to connect the control points listed below. + */ + interpolationType?: string | null; + } + /** + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { + /** + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + */ + attributeValue?: string | null; + /** + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + */ + boostAmount?: number | null; + } /** * A specification for configuring the behavior of content search. */ @@ -7502,6 +7823,10 @@ export namespace discoveryengine_v1 { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -7561,6 +7886,10 @@ export namespace discoveryengine_v1 { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * A facet specification to perform faceted search. @@ -7911,6 +8240,15 @@ export namespace discoveryengine_v1 { */ summary?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * External session proto definition. */ @@ -8332,6 +8670,14 @@ export namespace discoveryengine_v1 { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -8543,7 +8889,7 @@ export namespace discoveryengine_v1 { collections: Resource$Projects$Locations$Collections; dataStores: Resource$Projects$Locations$Datastores; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; + identityMappingStores: Resource$Projects$Locations$Identitymappingstores; operations: Resource$Projects$Locations$Operations; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; userEvents: Resource$Projects$Locations$Userevents; @@ -8558,8 +8904,8 @@ export namespace discoveryengine_v1 { this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( this.context ); - this.identity_mapping_stores = - new Resource$Projects$Locations$Identity_mapping_stores(this.context); + this.identityMappingStores = + new Resource$Projects$Locations$Identitymappingstores(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -11745,7 +12091,7 @@ export namespace discoveryengine_v1 { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -11757,14 +12103,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -11783,7 +12129,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -12393,7 +12739,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -12405,7 +12751,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -12417,14 +12763,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -12447,7 +12793,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -14665,7 +15011,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -14677,14 +15023,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -14707,7 +15053,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -14834,7 +15180,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -17164,7 +17510,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -17756,7 +18102,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -18264,7 +18610,7 @@ export namespace discoveryengine_v1 { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -18276,14 +18622,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -18302,7 +18648,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -18912,7 +19258,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -18924,7 +19270,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -18936,14 +19282,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -18966,7 +19312,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -20050,7 +20396,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -20062,14 +20408,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -20092,7 +20438,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -20219,7 +20565,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -23233,7 +23579,7 @@ export namespace discoveryengine_v1 { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -23245,14 +23591,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -23271,7 +23617,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -23881,7 +24227,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -23893,7 +24239,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -23905,14 +24251,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -23935,7 +24281,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -25807,7 +26153,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -25819,14 +26165,14 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -25849,7 +26195,7 @@ export namespace discoveryengine_v1 { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -25976,7 +26322,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -27620,7 +27966,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -27765,19 +28111,19 @@ export namespace discoveryengine_v1 { requestBody?: Schema$GoogleCloudDiscoveryengineV1CheckGroundingRequest; } - export class Resource$Projects$Locations$Identity_mapping_stores { + export class Resource$Projects$Locations$Identitymappingstores { context: APIRequestContext; - operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + operations: Resource$Projects$Locations$Identitymappingstores$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Identity_mapping_stores$Operations( + new Resource$Projects$Locations$Identitymappingstores$Operations( this.context ); } } - export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + export class Resource$Projects$Locations$Identitymappingstores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -27792,27 +28138,27 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -27820,7 +28166,7 @@ export namespace discoveryengine_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27836,13 +28182,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; options = {}; } @@ -27886,27 +28232,27 @@ export namespace discoveryengine_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -27914,7 +28260,7 @@ export namespace discoveryengine_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27930,13 +28276,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; options = {}; } @@ -27977,14 +28323,14 @@ export namespace discoveryengine_v1 { } } - export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List extends StandardParameters { /** * The standard list filter. @@ -28337,7 +28683,7 @@ export namespace discoveryengine_v1 { export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. */ rankingConfig?: string; diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 6cc857a127..533915a080 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -501,7 +501,7 @@ export namespace discoveryengine_v1alpha { */ answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec; /** - * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + * Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */ asynchronousMode?: boolean | null; /** @@ -549,6 +549,10 @@ export namespace discoveryengine_v1alpha { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */ @@ -678,6 +682,10 @@ export namespace discoveryengine_v1alpha { * Number of search results to return. The default value is 10. */ maxReturnResults?: number | null; + /** + * Optional. Specification to enable natural language understanding capabilities for search requests. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ @@ -721,6 +729,23 @@ export namespace discoveryengine_v1alpha { * Chunk textual content. */ content?: string | null; + /** + * Metadata of the document from the current chunk. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata; + } + /** + * Document metadata contains the information of the document of the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata { + /** + * Title of the document. + */ + title?: string | null; + /** + * Uri of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -731,11 +756,11 @@ export namespace discoveryengine_v1alpha { */ document?: string | null; /** - * List of document contexts. + * List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive. */ documentContexts?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; /** - * List of extractive answers. + * Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers. */ extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; /** @@ -756,7 +781,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { /** - * Document content. + * Document content to be used for answer generation. */ content?: string | null; /** @@ -778,7 +803,7 @@ export namespace discoveryengine_v1alpha { pageIdentifier?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { /** @@ -1004,7 +1029,7 @@ export namespace discoveryengine_v1alpha { */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */ structData?: {[key: string]: any} | null; /** @@ -1112,9 +1137,9 @@ export namespace discoveryengine_v1alpha { */ matcherValue?: Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; /** - * The status of the document. + * The state of the document. */ - status?: string | null; + state?: string | null; } /** * The value of the matcher that was used to match the Document. @@ -1774,7 +1799,7 @@ export namespace discoveryengine_v1alpha { */ safeSearch?: boolean | null; /** - * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. + * The resource name of the Serving Config to use. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. */ servingConfig?: string | null; /** @@ -1910,6 +1935,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -1923,7 +1952,7 @@ export namespace discoveryengine_v1alpha { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -1939,6 +1968,10 @@ export namespace discoveryengine_v1alpha { * 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; + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -1975,6 +2008,14 @@ export namespace discoveryengine_v1alpha { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -1988,6 +2029,35 @@ export namespace discoveryengine_v1alpha { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -2081,6 +2151,10 @@ export namespace discoveryengine_v1alpha { * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ id?: string | null; + /** + * Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + */ + indexStatus?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus; /** * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */ @@ -2145,6 +2219,19 @@ export namespace discoveryengine_v1alpha { */ uri?: string | null; } + /** + * Index status of the document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus { + /** + * A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The time when the document was indexed. If this field is populated, it means the document has been indexed. + */ + indexTime?: string | null; + } /** * Detailed document information associated with a user event. */ @@ -2158,7 +2245,7 @@ export namespace discoveryengine_v1alpha { */ joined?: boolean | null; /** - * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` + * The Document resource full name, of the form: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` */ name?: string | null; /** @@ -2191,7 +2278,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -2322,6 +2409,10 @@ export namespace discoveryengine_v1alpha { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -2335,7 +2426,7 @@ export namespace discoveryengine_v1alpha { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -2703,6 +2794,10 @@ export namespace discoveryengine_v1alpha { * Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. */ keyPropertyType?: string | null; + /** + * Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + */ + metatagName?: string | null; /** * If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. */ @@ -3451,6 +3546,15 @@ export namespace discoveryengine_v1alpha { */ mediaProgressPercentage?: number | null; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Detailed page information. */ @@ -3532,7 +3636,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -3996,6 +4100,10 @@ export namespace discoveryengine_v1alpha { * Request message for SiteSearchEngineService.RecrawlUris method. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest { + /** + * Optional. Full resource name of the SiteCredential, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + */ + siteCredential?: string | null; /** * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */ @@ -4373,6 +4481,10 @@ export namespace discoveryengine_v1alpha { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -4578,6 +4690,10 @@ export namespace discoveryengine_v1alpha { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -4637,6 +4753,10 @@ export namespace discoveryengine_v1alpha { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -4736,6 +4856,15 @@ export namespace discoveryengine_v1alpha { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -5293,6 +5422,10 @@ export namespace discoveryengine_v1alpha { * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ onewaySynonymsControlIds?: string[] | null; + /** + * The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec; /** * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ @@ -5318,6 +5451,15 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. */ @@ -5674,7 +5816,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -5820,6 +5962,14 @@ export namespace discoveryengine_v1alpha { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -6069,6 +6219,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -6082,7 +6236,7 @@ export namespace discoveryengine_v1alpha { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -6094,6 +6248,10 @@ export namespace discoveryengine_v1alpha { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -6126,6 +6284,14 @@ export namespace discoveryengine_v1alpha { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -6139,6 +6305,35 @@ export namespace discoveryengine_v1alpha { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -6225,7 +6420,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -6334,6 +6529,10 @@ export namespace discoveryengine_v1alpha { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -6343,7 +6542,7 @@ export namespace discoveryengine_v1alpha { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -6725,6 +6924,15 @@ export namespace discoveryengine_v1alpha { */ models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -6734,7 +6942,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -6972,6 +7180,10 @@ export namespace discoveryengine_v1alpha { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -7177,6 +7389,10 @@ export namespace discoveryengine_v1alpha { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -7236,6 +7452,10 @@ export namespace discoveryengine_v1alpha { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -7335,6 +7555,15 @@ export namespace discoveryengine_v1alpha { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -7379,6 +7608,15 @@ export namespace discoveryengine_v1alpha { */ mode?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Verification information for target sites in advanced site search. */ @@ -7498,7 +7736,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -7553,6 +7791,14 @@ export namespace discoveryengine_v1alpha { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -7746,6 +7992,10 @@ export namespace discoveryengine_v1alpha { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -7774,6 +8024,10 @@ export namespace discoveryengine_v1alpha { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -7787,6 +8041,35 @@ export namespace discoveryengine_v1alpha { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7873,7 +8156,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -7982,6 +8265,10 @@ export namespace discoveryengine_v1alpha { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -7991,7 +8278,7 @@ export namespace discoveryengine_v1alpha { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -8234,7 +8521,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -8384,6 +8671,15 @@ export namespace discoveryengine_v1alpha { */ structSchema?: {[key: string]: any} | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Verification information for target sites in advanced site search. */ @@ -8532,6 +8828,14 @@ export namespace discoveryengine_v1alpha { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -9000,7 +9304,7 @@ export namespace discoveryengine_v1alpha { dataStores: Resource$Projects$Locations$Datastores; evaluations: Resource$Projects$Locations$Evaluations; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; + identityMappingStores: Resource$Projects$Locations$Identitymappingstores; operations: Resource$Projects$Locations$Operations; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; requirements: Resource$Projects$Locations$Requirements; @@ -9021,8 +9325,8 @@ export namespace discoveryengine_v1alpha { this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( this.context ); - this.identity_mapping_stores = - new Resource$Projects$Locations$Identity_mapping_stores(this.context); + this.identityMappingStores = + new Resource$Projects$Locations$Identitymappingstores(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -10725,7 +11029,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig extends StandardParameters { /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` */ name?: string; } @@ -13096,7 +13400,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -13108,14 +13412,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -13134,7 +13438,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -13744,7 +14048,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -13756,7 +14060,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -13768,14 +14072,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -13798,7 +14102,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -15790,7 +16094,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -15805,7 +16109,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -16345,7 +16649,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -16357,14 +16661,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -16387,7 +16691,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -16514,7 +16818,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -19056,7 +19360,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -19943,7 +20247,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -19959,7 +20263,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Pause extends StandardParameters { /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -19971,7 +20275,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Resume extends StandardParameters { /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -19983,7 +20287,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Tune extends StandardParameters { /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -20487,7 +20791,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -20499,14 +20803,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -20525,7 +20829,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -21135,7 +21439,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -21147,7 +21451,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -21159,14 +21463,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -21189,7 +21493,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -22047,7 +22351,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -22062,7 +22366,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -22602,7 +22906,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -22614,14 +22918,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -22644,7 +22948,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -22771,7 +23075,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -23987,7 +24291,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig extends StandardParameters { /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` */ name?: string; } @@ -26346,7 +26650,7 @@ export namespace discoveryengine_v1alpha { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -26358,14 +26662,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -26384,7 +26688,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -26994,7 +27298,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -27006,7 +27310,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -27018,14 +27322,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -27048,7 +27352,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -28694,7 +28998,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -28709,7 +29013,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -29249,7 +29553,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -29261,14 +29565,14 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -29291,7 +29595,7 @@ export namespace discoveryengine_v1alpha { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -29418,7 +29722,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -31061,7 +31365,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -31764,19 +32068,19 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; } - export class Resource$Projects$Locations$Identity_mapping_stores { + export class Resource$Projects$Locations$Identitymappingstores { context: APIRequestContext; - operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + operations: Resource$Projects$Locations$Identitymappingstores$Operations; constructor(context: APIRequestContext) { this.context = context; this.operations = - new Resource$Projects$Locations$Identity_mapping_stores$Operations( + new Resource$Projects$Locations$Identitymappingstores$Operations( this.context ); } } - export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + export class Resource$Projects$Locations$Identitymappingstores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -31791,27 +32095,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -31819,7 +32123,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -31835,13 +32139,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; options = {}; } @@ -31885,27 +32189,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -31913,7 +32217,7 @@ export namespace discoveryengine_v1alpha { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -31929,13 +32233,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; options = {}; } @@ -31976,14 +32280,14 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List extends StandardParameters { /** * The standard list filter. @@ -32336,7 +32640,7 @@ export namespace discoveryengine_v1alpha { export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. */ rankingConfig?: string; diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 2c6aa93856..3c06b423f4 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -524,7 +524,7 @@ export namespace discoveryengine_v1beta { */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */ structData?: {[key: string]: any} | null; /** @@ -806,6 +806,10 @@ export namespace discoveryengine_v1beta { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -819,7 +823,7 @@ export namespace discoveryengine_v1beta { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -835,6 +839,10 @@ export namespace discoveryengine_v1beta { * 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; + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -871,6 +879,14 @@ export namespace discoveryengine_v1beta { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -884,6 +900,35 @@ export namespace discoveryengine_v1beta { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -970,7 +1015,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -1079,6 +1124,10 @@ export namespace discoveryengine_v1beta { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -1092,7 +1141,7 @@ export namespace discoveryengine_v1beta { */ mediaRecommendationEngineConfig?: Schema$GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -1353,6 +1402,10 @@ export namespace discoveryengine_v1beta { * Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified. */ keyPropertyType?: string | null; + /** + * Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag. + */ + metatagName?: string | null; /** * If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned. */ @@ -1643,6 +1696,15 @@ export namespace discoveryengine_v1beta { */ models?: Schema$GoogleCloudDiscoveryengineV1alphaCustomTuningModel[]; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Metadata and configurations for a Google Cloud project in the service. */ @@ -1652,7 +1714,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -2041,6 +2103,10 @@ export namespace discoveryengine_v1beta { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -2246,6 +2312,10 @@ export namespace discoveryengine_v1beta { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -2305,6 +2375,10 @@ export namespace discoveryengine_v1beta { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -2404,6 +2478,15 @@ export namespace discoveryengine_v1beta { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -2448,6 +2531,15 @@ export namespace discoveryengine_v1beta { */ mode?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * External session proto definition. */ @@ -2626,7 +2718,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -2681,6 +2773,14 @@ export namespace discoveryengine_v1beta { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -2821,7 +2921,7 @@ export namespace discoveryengine_v1beta { */ answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec; /** - * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + * Deprecated: This field is deprecated. Streaming Answer API will be supported. Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */ asynchronousMode?: boolean | null; /** @@ -2869,6 +2969,10 @@ export namespace discoveryengine_v1beta { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */ @@ -2994,6 +3098,10 @@ export namespace discoveryengine_v1beta { * Number of search results to return. The default value is 10. */ maxReturnResults?: number | null; + /** + * Optional. Specification to enable natural language understanding capabilities for search requests. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ @@ -3037,6 +3145,23 @@ export namespace discoveryengine_v1beta { * Chunk textual content. */ content?: string | null; + /** + * Metadata of the document from the current chunk. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata; + } + /** + * Document metadata contains the information of the document of the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfoDocumentMetadata { + /** + * Title of the document. + */ + title?: string | null; + /** + * Uri of the document. + */ + uri?: string | null; } /** * Unstructured document information. @@ -3047,11 +3172,11 @@ export namespace discoveryengine_v1beta { */ document?: string | null; /** - * List of document contexts. + * List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive. */ documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; /** - * List of extractive answers. + * Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers. */ extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; /** @@ -3072,7 +3197,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { /** - * Document content. + * Document content to be used for answer generation. */ content?: string | null; /** @@ -3094,7 +3219,7 @@ export namespace discoveryengine_v1beta { pageIdentifier?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) Answer generation will only use it if document_contexts is empty. This is supposed to be shorter snippets. */ export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { /** @@ -3320,7 +3445,7 @@ export namespace discoveryengine_v1beta { */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result. . */ structData?: {[key: string]: any} | null; /** @@ -3428,9 +3553,9 @@ export namespace discoveryengine_v1beta { */ matcherValue?: Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; /** - * The status of the document. + * The state of the document. */ - status?: string | null; + state?: string | null; } /** * The value of the matcher that was used to match the Document. @@ -4027,7 +4152,7 @@ export namespace discoveryengine_v1beta { */ safeSearch?: boolean | null; /** - * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. + * The resource name of the Serving Config to use. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. */ servingConfig?: string | null; /** @@ -4154,6 +4279,10 @@ export namespace discoveryengine_v1beta { * The display name of the model. */ displayName?: string | null; + /** + * Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`. + */ + errorMessage?: string | null; /** * The metrics of the trained model. */ @@ -4167,7 +4296,7 @@ export namespace discoveryengine_v1beta { */ modelVersion?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Required. The fully qualified resource name of the model. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}`. Model must be an alpha-numerical string with limit of 40 characters. */ name?: string | null; /** @@ -4179,6 +4308,10 @@ export namespace discoveryengine_v1beta { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -4211,6 +4344,14 @@ export namespace discoveryengine_v1beta { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Configuration for Natural Language Query Understanding. + */ + naturalLanguageQueryUnderstandingConfig?: Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -4224,6 +4365,35 @@ export namespace discoveryengine_v1beta { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -4313,6 +4483,10 @@ export namespace discoveryengine_v1beta { * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ id?: string | null; + /** + * Output only. The index status of the document. * If document is indexed successfully, the index_time field is populated. * Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, index_status is unset. + */ + indexStatus?: Schema$GoogleCloudDiscoveryengineV1betaDocumentIndexStatus; /** * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */ @@ -4355,6 +4529,19 @@ export namespace discoveryengine_v1beta { */ uri?: string | null; } + /** + * Index status of the document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentIndexStatus { + /** + * A sample of errors encountered while indexing the document. If this field is populated, the document is not indexed due to errors. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The time when the document was indexed. If this field is populated, it means the document has been indexed. + */ + indexTime?: string | null; + } /** * Detailed document information associated with a user event. */ @@ -4368,7 +4555,7 @@ export namespace discoveryengine_v1beta { */ joined?: boolean | null; /** - * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` + * The Document resource full name, of the form: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` */ name?: string | null; /** @@ -4401,7 +4588,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -4532,6 +4719,10 @@ export namespace discoveryengine_v1beta { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -4541,7 +4732,7 @@ export namespace discoveryengine_v1beta { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -5406,6 +5597,15 @@ export namespace discoveryengine_v1beta { */ mediaProgressPercentage?: number | null; } + /** + * Configuration for Natural Language Query Understanding. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaNaturalLanguageQueryUnderstandingConfig { + /** + * Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. + */ + mode?: string | null; + } /** * Detailed page information. */ @@ -5461,7 +5661,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -5834,6 +6034,10 @@ export namespace discoveryengine_v1beta { * Request message for SiteSearchEngineService.RecrawlUris method. */ export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { + /** + * Optional. Full resource name of the SiteCredential, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine/siteCredentials/x`. Only set to crawl private URIs. + */ + siteCredential?: string | null; /** * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */ @@ -6051,6 +6255,10 @@ export namespace discoveryengine_v1beta { * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ params?: {[key: string]: any} | null; + /** + * The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec; /** * Raw search query. */ @@ -6256,6 +6464,10 @@ export namespace discoveryengine_v1beta { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Optional. Specifies whether to filter out jail-breaking queries. The default value is `false`. Google employs search-query classification to detect jail-breaking queries. No summary is returned if the search query is classified as a jail-breaking query. A user might add instructions to the query to change the tone, style, language, content of the answer, or ask the model to act as a different entity, e.g. "Reply in the tone of a competing company's CEO". If this field is set to `true`, we skip generating summaries for jail-breaking queries and return fallback messages instead. + */ + ignoreJailBreakingQuery?: boolean | null; /** * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ @@ -6315,6 +6527,10 @@ export namespace discoveryengine_v1beta { * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ dataStore?: string | null; + /** + * Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; } /** * The specification that uses customized query embedding vector to do semantic document retrieval. @@ -6414,6 +6630,15 @@ export namespace discoveryengine_v1beta { */ geoSearchQueryDetectionFieldNames?: string[] | null; } + /** + * The specification for personalization. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec { + /** + * The personalization mode of the search request. Defaults to Mode.AUTO. + */ + mode?: string | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -6963,6 +7188,10 @@ export namespace discoveryengine_v1beta { * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ onewaySynonymsControlIds?: string[] | null; + /** + * The specification for personalization spec. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set, SearchRequest.personalization_spec overrides ServingConfig.personalization_spec. + */ + personalizationSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestPersonalizationSpec; /** * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ @@ -6988,6 +7217,15 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. */ @@ -7310,7 +7548,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ engine?: string | null; } @@ -7456,6 +7694,14 @@ export namespace discoveryengine_v1beta { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -7649,6 +7895,10 @@ export namespace discoveryengine_v1beta { * DataStore captures global settings and configs at the DataStore level. */ export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * Output only. Data size estimation for billing. + */ + billingEstimation?: Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation; /** * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ @@ -7677,6 +7927,10 @@ export namespace discoveryengine_v1beta { * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * Optional. Stores serving config at DataStore level. + */ + servingConfigDataStore?: Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore; /** * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ @@ -7690,6 +7944,35 @@ export namespace discoveryengine_v1beta { */ workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; } + /** + * Estimation of data size per data store. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataStoreBillingEstimation { + /** + * Data size for structured data in terms of bytes. + */ + structuredDataSize?: string | null; + /** + * Last updated timestamp for structured data. + */ + structuredDataUpdateTime?: string | null; + /** + * Data size for unstructured data in terms of bytes. + */ + unstructuredDataSize?: string | null; + /** + * Last updated timestamp for unstructured data. + */ + unstructuredDataUpdateTime?: string | null; + /** + * Data size for websites in terms of bytes. + */ + websiteDataSize?: string | null; + /** + * Last updated timestamp for websites. + */ + websiteDataUpdateTime?: string | null; + } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -7776,7 +8059,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsm`: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -7885,6 +8168,10 @@ export namespace discoveryengine_v1beta { * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ dataStoreIds?: string[] | null; + /** + * Optional. Whether to disable analytics for searches performed on this engine. + */ + disableAnalytics?: boolean | null; /** * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ @@ -7894,7 +8181,7 @@ export namespace discoveryengine_v1beta { */ industryVertical?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string | null; /** @@ -8137,7 +8424,7 @@ export namespace discoveryengine_v1beta { */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. Full resource name of the project, for example `projects/{project\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ name?: string | null; /** @@ -8287,6 +8574,15 @@ export namespace discoveryengine_v1beta { */ structSchema?: {[key: string]: any} | null; } + /** + * Stores information regarding the serving configurations at DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ServingConfigDataStore { + /** + * If set true, the DataStore will not be available for serving search requests. + */ + disabledForServing?: boolean | null; + } /** * Verification information for target sites in advanced site search. */ @@ -8435,6 +8731,14 @@ export namespace discoveryengine_v1beta { * Obfuscated Dasher customer ID. */ dasherCustomerId?: string | null; + /** + * Optional. The super admin email address for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminEmailAddress?: string | null; + /** + * Optional. The super admin service account for the workspace that will be used for access token generation. For now we only use it for Native Google Drive connector data ingestion. + */ + superAdminServiceAccount?: string | null; /** * The Google Workspace data source. */ @@ -8647,6 +8951,7 @@ export namespace discoveryengine_v1beta { dataStores: Resource$Projects$Locations$Datastores; evaluations: Resource$Projects$Locations$Evaluations; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identityMappingStores: Resource$Projects$Locations$Identitymappingstores; operations: Resource$Projects$Locations$Operations; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; sampleQuerySets: Resource$Projects$Locations$Samplequerysets; @@ -8665,6 +8970,8 @@ export namespace discoveryengine_v1beta { 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 ); @@ -11855,7 +12162,7 @@ export namespace discoveryengine_v1beta { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -11867,14 +12174,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -11893,7 +12200,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -12503,7 +12810,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -12515,7 +12822,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -12527,14 +12834,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -12557,7 +12864,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -14549,7 +14856,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -14564,7 +14871,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -15104,7 +15411,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -15116,14 +15423,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -15146,7 +15453,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -15273,7 +15580,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -17603,7 +17910,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -18490,7 +18797,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; /** @@ -18506,7 +18813,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Pause extends StandardParameters { /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The name of the engine to pause. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -18518,7 +18825,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Resume extends StandardParameters { /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The name of the engine to resume. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -18530,7 +18837,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Tune extends StandardParameters { /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the engine to tune. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}` */ name?: string; @@ -19034,7 +19341,7 @@ export namespace discoveryengine_v1beta { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -19046,14 +19353,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -19072,7 +19379,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -19682,7 +19989,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -19694,7 +20001,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -19706,14 +20013,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -19736,7 +20043,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -20594,7 +20901,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -20609,7 +20916,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -21149,7 +21456,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -21161,14 +21468,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -21191,7 +21498,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -21318,7 +21625,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -24334,7 +24641,7 @@ export namespace discoveryengine_v1beta { */ controlId?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; @@ -24346,14 +24653,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Controls$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Control to get. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } @@ -24372,7 +24679,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; } @@ -24982,7 +25289,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ name?: string; @@ -24994,7 +25301,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -25006,14 +25313,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Conversation to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } @@ -25036,7 +25343,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -26682,7 +26989,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } @@ -26697,7 +27004,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. Full resource name of the parent resource. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } @@ -27237,7 +27544,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. Full resource name of parent data store. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; @@ -27249,14 +27556,14 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } @@ -27279,7 +27586,7 @@ export namespace discoveryengine_v1beta { */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The data store resource name. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } @@ -27406,7 +27713,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + * Required. The resource name of the Answer to get. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; } @@ -29049,7 +29356,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Required. The resource name of the catalog under which the events are created. The format is `projects/{project\}/locations/global/collections/{collection\}/dataStores/{dataStore\}`. */ parent?: string; @@ -29752,6 +30059,245 @@ export namespace discoveryengine_v1beta { requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest; } + export class Resource$Projects$Locations$Identitymappingstores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identitymappingstores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identitymappingstores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Identitymappingstores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identitymappingstores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identitymappingstores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identitymappingstores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identitymappingstores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -30085,7 +30631,7 @@ export namespace discoveryengine_v1beta { export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location\}/rankingConfigs/default_ranking_config`. */ rankingConfig?: string; diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index a98b5ac20e..9fca68b0f6 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -3221,7 +3221,7 @@ export namespace displayvideo_v2 { */ name?: string | null; /** - * Required. The budget spending speed setting of the insertion order. + * Required. The budget spending speed setting of the insertion order. *Warning*: Starting on **November 5, 2024**, pacing_type `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT`. [Read more about this announced change](/display-video/api/deprecations#features.io_asap). */ pacing?: Schema$Pacing; /** @@ -4658,7 +4658,7 @@ export namespace displayvideo_v2 { */ pacingPeriod?: string | null; /** - * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. + * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. *Warning*: Starting on **November 5, 2024**, `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. [Read more about this announced change](/display-video/api/deprecations#features.io_asap). */ pacingType?: string | null; } diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index e57aa5e515..34492e8846 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -3556,7 +3556,7 @@ export namespace displayvideo_v3 { */ optimizationObjective?: string | null; /** - * Required. The budget spending speed setting of the insertion order. + * Required. The budget spending speed setting of the insertion order. *Warning*: Starting on **November 5, 2024**, pacing_type `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT`. [Read more about this announced change](/display-video/api/deprecations#features.io_asap). */ pacing?: Schema$Pacing; /** @@ -4981,7 +4981,7 @@ export namespace displayvideo_v3 { */ pacingPeriod?: string | null; /** - * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. + * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. *Warning*: Starting on **November 5, 2024**, `PACING_TYPE_ASAP` will no longer be compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. [Read more about this announced change](/display-video/api/deprecations#features.io_asap). */ pacingType?: string | null; } @@ -5657,7 +5657,7 @@ export namespace displayvideo_v3 { */ audienceExpansionSeedListExcluded?: boolean | null; /** - * Required. Whether to enable Optimized Targeting for the line item. + * Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` */ enableOptimizedTargeting?: boolean | null; } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index ad0d916536..acf642e079 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -196,6 +196,45 @@ export namespace dlp_v2 { * Apply to all text. */ export interface Schema$GooglePrivacyDlpV2AllText {} + /** + * Amazon S3 bucket. + */ + export interface Schema$GooglePrivacyDlpV2AmazonS3Bucket { + /** + * The AWS account. + */ + awsAccount?: Schema$GooglePrivacyDlpV2AwsAccount; + /** + * Required. The bucket name. + */ + bucketName?: string | null; + } + /** + * Amazon S3 bucket conditions. + */ + export interface Schema$GooglePrivacyDlpV2AmazonS3BucketConditions { + /** + * Optional. Bucket types that should be profiled. Optional. Defaults to TYPE_ALL_SUPPORTED if unspecified. + */ + bucketTypes?: string[] | null; + /** + * Optional. Object classes that should be profiled. Optional. Defaults to ALL_SUPPORTED_CLASSES if unspecified. + */ + objectStorageClasses?: string[] | null; + } + /** + * Amazon S3 bucket regex. + */ + export interface Schema$GooglePrivacyDlpV2AmazonS3BucketRegex { + /** + * The AWS account regex. + */ + awsAccountRegex?: Schema$GooglePrivacyDlpV2AwsAccountRegex; + /** + * Optional. Regex to test the bucket name against. If empty, all buckets match. + */ + bucketNameRegex?: string | null; + } /** * Result of a risk analysis operation request. */ @@ -254,6 +293,37 @@ export namespace dlp_v2 { */ table?: Schema$GooglePrivacyDlpV2BigQueryTable; } + /** + * AWS account. + */ + export interface Schema$GooglePrivacyDlpV2AwsAccount { + /** + * Required. AWS account ID. + */ + accountId?: string | null; + } + /** + * AWS account regex. + */ + export interface Schema$GooglePrivacyDlpV2AwsAccountRegex { + /** + * Optional. Regex to test the AWS account ID against. If empty, all accounts match. + */ + accountIdRegex?: string | null; + } + /** + * The AWS starting location for discovery. + */ + export interface Schema$GooglePrivacyDlpV2AwsDiscoveryStartingLocation { + /** + * The AWS account ID that this discovery config applies to. Within an AWS organization, you can find the AWS account ID inside an AWS account ARN. Example: arn:{partition\}:organizations::{management_account_id\}:account/{org_id\}/{account_id\} + */ + accountId?: string | null; + /** + * All AWS assets stored in Asset Inventory that didn't match other AWS discovery configs. + */ + allAssetInventoryAssets?: boolean | null; + } /** * Target used to match against for discovery with BigQuery tables */ @@ -1221,6 +1291,14 @@ export namespace dlp_v2 { * Export data profiles into a provided location. */ exportData?: Schema$GooglePrivacyDlpV2Export; + /** + * Publishes generated data profiles to Google Security Operations. For more information, see [Use Sensitive Data Protection data in context-aware analytics](https://cloud.google.com/chronicle/docs/detection/usecase-dlp-high-risk-user-download). + */ + publishToChronicle?: Schema$GooglePrivacyDlpV2PublishToChronicle; + /** + * Publishes findings to SCC for each data profile. + */ + publishToScc?: Schema$GooglePrivacyDlpV2PublishToSecurityCommandCenter; /** * Publish a message into the Pub/Sub topic. */ @@ -1288,6 +1366,10 @@ export namespace dlp_v2 { * The data to scan. */ location?: Schema$GooglePrivacyDlpV2DataProfileLocation; + /** + * Must be set only when scanning other clouds. + */ + otherCloudStartingLocation?: Schema$GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation; /** * The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. */ @@ -1811,6 +1893,10 @@ export namespace dlp_v2 { * Only set when the parent is an org. */ orgConfig?: Schema$GooglePrivacyDlpV2OrgConfig; + /** + * Must be set only when scanning other clouds. + */ + otherCloudStartingLocation?: Schema$GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation; /** * Required. A status for this configuration. */ @@ -1871,6 +1957,49 @@ export namespace dlp_v2 { */ frequency?: string | null; } + /** + * Requirements that must be true before a resource is profiled for the first time. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryOtherCloudConditions { + /** + * Amazon S3 bucket conditions. + */ + amazonS3BucketConditions?: Schema$GooglePrivacyDlpV2AmazonS3BucketConditions; + /** + * Minimum age a resource must be before Cloud DLP can profile it. Value must be 1 hour or greater. + */ + minAge?: string | null; + } + /** + * Determines which resources from the other cloud will have profiles generated. Includes the ability to filter by resource names. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryOtherCloudFilter { + /** + * A collection of resources for this filter to apply to. + */ + collection?: Schema$GooglePrivacyDlpV2OtherCloudResourceCollection; + /** + * Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + */ + others?: Schema$GooglePrivacyDlpV2AllOtherResources; + /** + * The resource to scan. Configs using this filter can only have one target (the target with this single resource reference). + */ + singleResource?: Schema$GooglePrivacyDlpV2OtherCloudSingleResourceReference; + } + /** + * How often existing resources should have their profiles refreshed. New resources are scanned as quickly as possible depending on system capacity. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence { + /** + * Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; + /** + * Optional. Frequency to update profiles regardless of whether the underlying resource has changes. Defaults to never. + */ + refreshFrequency?: string | null; + } /** * The cadence at which to update data profiles when a schema is modified. */ @@ -1926,6 +2055,10 @@ export namespace dlp_v2 { * Cloud Storage target for Discovery. The first target to match a table will be the one applied. */ cloudStorageTarget?: Schema$GooglePrivacyDlpV2CloudStorageDiscoveryTarget; + /** + * Other clouds target for discovery. The first target to match a resource will be the one applied. + */ + otherCloudTarget?: Schema$GooglePrivacyDlpV2OtherCloudDiscoveryTarget; /** * Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. */ @@ -2196,7 +2329,7 @@ export namespace dlp_v2 { includeRegexes?: Schema$GooglePrivacyDlpV2FileStoreRegexes; } /** - * The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. + * The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. * Amazon S3: maps 1:1 with a bucket. */ export interface Schema$GooglePrivacyDlpV2FileStoreDataProfile { /** @@ -2232,15 +2365,15 @@ export namespace dlp_v2 { */ fileStoreIsEmpty?: boolean | null; /** - * The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations + * The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations * Amazon S3: https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints */ fileStoreLocation?: string | null; /** - * The file store path. * Cloud Storage: `gs://{bucket\}` + * The file store path. * Cloud Storage: `gs://{bucket\}` * Amazon S3: `s3://{bucket\}` */ fileStorePath?: string | null; /** - * The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name + * The resource name of the resource profiled. https://cloud.google.com/apis/design/resource_names#full_resource_name Example format of an S3 bucket full resource name: `//cloudasset.googleapis.com/organizations/{org_id\}/otherCloudConnections/aws/arn:aws:s3:::{bucket_name\}` */ fullResource?: string | null; /** @@ -2268,7 +2401,7 @@ export namespace dlp_v2 { */ projectDataProfile?: string | null; /** - * The Google Cloud project ID that owns the resource. + * The Google Cloud project ID that owns the resource. For Amazon S3 buckets, this is the AWS Account Id. */ projectId?: string | null; /** @@ -3460,6 +3593,76 @@ export namespace dlp_v2 { */ projectId?: string | null; } + /** + * The other cloud starting location for discovery. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudDiscoveryStartingLocation { + /** + * The AWS starting location for discovery. + */ + awsLocation?: Schema$GooglePrivacyDlpV2AwsDiscoveryStartingLocation; + } + /** + * Target used to match against for discovery of resources from other clouds. An [AWS connector in Security Command Center (Enterprise](https://cloud.google.com/security-command-center/docs/connect-scc-to-aws) is required to use this feature. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudDiscoveryTarget { + /** + * Optional. In addition to matching the filter, these conditions must be true before a profile is generated. + */ + conditions?: Schema$GooglePrivacyDlpV2DiscoveryOtherCloudConditions; + /** + * Required. The type of data profiles generated by this discovery target. Supported values are: * aws/s3/bucket + */ + dataSourceType?: Schema$GooglePrivacyDlpV2DataSourceType; + /** + * Disable profiling for resources that match this filter. + */ + disabled?: Schema$GooglePrivacyDlpV2Disabled; + /** + * Required. The resources that the discovery cadence applies to. The first target with a matching filter will be the one to apply to a resource. + */ + filter?: Schema$GooglePrivacyDlpV2DiscoveryOtherCloudFilter; + /** + * How often and when to update data profiles. New resources that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + */ + generationCadence?: Schema$GooglePrivacyDlpV2DiscoveryOtherCloudGenerationCadence; + } + /** + * Match resources using regex filters. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudResourceCollection { + /** + * A collection of regular expressions to match a resource against. + */ + includeRegexes?: Schema$GooglePrivacyDlpV2OtherCloudResourceRegexes; + } + /** + * A pattern to match against one or more resources. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudResourceRegex { + /** + * Regex for Amazon S3 buckets. + */ + amazonS3BucketRegex?: Schema$GooglePrivacyDlpV2AmazonS3BucketRegex; + } + /** + * A collection of regular expressions to determine what resources to match against. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudResourceRegexes { + /** + * A group of regular expression patterns to match against one or more resources. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + */ + patterns?: Schema$GooglePrivacyDlpV2OtherCloudResourceRegex[]; + } + /** + * Identifies a single resource, like a single Amazon S3 bucket. + */ + export interface Schema$GooglePrivacyDlpV2OtherCloudSingleResourceReference { + /** + * Amazon S3 bucket. + */ + amazonS3Bucket?: Schema$GooglePrivacyDlpV2AmazonS3Bucket; + } /** * Infotype details for other infoTypes found within a column. */ @@ -3673,6 +3876,10 @@ export namespace dlp_v2 { * Publish the result summary of a DlpJob to [Security Command Center](https://cloud.google.com/security-command-center). This action is available for only projects that belong to an organization. This action publishes the count of finding instances and their infoTypes. The summary of findings are persisted in Security Command Center and are governed by [service-specific policies for Security Command Center](https://cloud.google.com/terms/service-terms). Only a single instance of this action can be specified. Compatible with: Inspect */ export interface Schema$GooglePrivacyDlpV2PublishSummaryToCscc {} + /** + * Message expressing intention to publish to Google Security Operations. + */ + export interface Schema$GooglePrivacyDlpV2PublishToChronicle {} /** * Publish a message into a given Pub/Sub topic when DlpJob has completed. The message contains a single field, `DlpJobName`, which is equal to the finished job's [`DlpJob.name`](https://cloud.google.com/sensitive-data-protection/docs/reference/rest/v2/projects.dlpJobs#DlpJob). Compatible with: Inspect, Risk */ @@ -3682,6 +3889,10 @@ export namespace dlp_v2 { */ topic?: string | null; } + /** + * If set, a summary finding will be created/updated in SCC for each profile. + */ + export interface Schema$GooglePrivacyDlpV2PublishToSecurityCommandCenter {} /** * Enable Stackdriver metric dlp.googleapis.com/finding_count. This will publish a metric to stack driver on each infotype requested and how many findings were found for it. CustomDetectors will be bucketed as 'Custom' under the Stackdriver label 'info_type'. */ @@ -8805,7 +9016,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `account_id` - The AWS account ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** @@ -17706,7 +17917,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `account_id` - The AWS account ID. - `file_store_path` - The path like "gs://bucket". - `data_source_type` - The profile's data source type, like "google/storage/bucket". - `data_storage_location` - The location where the file store's data is stored, like "us-central1". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index ff710fad7b..ba60b04459 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -862,2455 +862,6 @@ export namespace documentai_v1 { * Response message for BatchProcessDocuments. */ export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} - /** - * Encodes the detailed information of a barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1Barcode { - /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - */ - format?: string | null; - /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - */ - rawValue?: string | null; - /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. - */ - valueFormat?: string | null; - } - /** - * Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse { - /** - * Responses for each individual document. - */ - responses?: Schema$GoogleCloudDocumentaiV1beta1ProcessDocumentResponse[]; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta1NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudDocumentaiV1beta1Vertex[]; - } - /** - * 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$GoogleCloudDocumentaiV1beta1Document { - /** - * Document chunked based on chunking config. - */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocument; - /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - */ - content?: string | null; - /** - * Parsed layout of the document. - */ - documentLayout?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayout; - /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - */ - entities?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntity[]; - /** - * Placeholder. Relationship among Document.entities. - */ - entityRelations?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntityRelation[]; - /** - * Any error that occurred while processing this document. - */ - error?: Schema$GoogleRpcStatus; - /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - */ - mimeType?: string | null; - /** - * Visual page layout for the Document. - */ - pages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPage[]; - /** - * Placeholder. Revision history of this document. - */ - revisions?: Schema$GoogleCloudDocumentaiV1beta1DocumentRevision[]; - /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. - */ - shardInfo?: Schema$GoogleCloudDocumentaiV1beta1DocumentShardInfo; - /** - * Optional. UTF-8 encoded text in reading order from the document. - */ - text?: string | null; - /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. - */ - textChanges?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextChange[]; - /** - * Styles for the Document.text. - */ - textStyles?: Schema$GoogleCloudDocumentaiV1beta1DocumentStyle[]; - /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). - */ - uri?: string | null; - } - /** - * Represents the chunks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocument { - /** - * List of chunks. - */ - chunks?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk[]; - } - /** - * Represents a chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk { - /** - * ID of the chunk. - */ - chunkId?: string | null; - /** - * Text content of the chunk. - */ - content?: string | null; - /** - * Page footers associated with the chunk. - */ - pageFooters?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter[]; - /** - * Page headers associated with the chunk. - */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader[]; - /** - * Page span of the chunk. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Unused. - */ - sourceBlockIds?: string[] | null; - } - /** - * Represents the page footer associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter { - /** - * Page span of the footer. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Footer in text format. - */ - text?: string | null; - } - /** - * Represents the page header associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader { - /** - * Page span of the header. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Header in text format. - */ - text?: string | null; - } - /** - * Represents where the chunk starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan { - /** - * Page where chunk ends in the document. - */ - pageEnd?: number | null; - /** - * Page where chunk starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayout { - /** - * List of blocks in the document. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents a block. A block could be one of the various types (text, table, list) supported. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock { - /** - * ID of the block. - */ - blockId?: string | null; - /** - * Block consisting of list content/structure. - */ - listBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; - /** - * Page span of the block. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; - /** - * Block consisting of table content/structure. - */ - tableBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; - /** - * Block consisting of text content. - */ - textBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; - } - /** - * Represents a list type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { - /** - * List entries that constitute a list block. - */ - listEntries?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; - /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - */ - type?: string | null; - } - /** - * Represents an entry in the list. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { - /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents where the block starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { - /** - * Page where block ends in the document. - */ - pageEnd?: number | null; - /** - * Page where block starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents a table type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { - /** - * Body rows containing main table content. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - /** - * Table caption/title. - */ - caption?: string | null; - /** - * Header rows at the top of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - } - /** - * Represents a cell in a table row. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { - /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * Represents a row in a table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { - /** - * A table row is a list of table cells. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; - } - /** - * Represents a text type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { - /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * Text content stored in the block. - */ - text?: string | null; - /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. - */ - type?: string | null; - } - /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntity { - /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. - */ - id?: string | null; - /** - * Optional. Deprecated. Use `id` field instead. - */ - mentionId?: string | null; - /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - */ - mentionText?: string | null; - /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue; - /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. - */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchor; - /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - */ - properties?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntity[]; - /** - * Optional. The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * Optional. Whether the entity will be redacted for de-identification purposes. - */ - redacted?: boolean | null; - /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - /** - * Required. Entity type from a schema e.g. `Address`. - */ - type?: string | null; - } - /** - * Parsed and normalized entity value. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue { - /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - */ - addressValue?: Schema$GoogleTypePostalAddress; - /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. - */ - booleanValue?: boolean | null; - /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - */ - datetimeValue?: Schema$GoogleTypeDateTime; - /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - */ - dateValue?: Schema$GoogleTypeDate; - /** - * Float value. - */ - floatValue?: number | null; - /** - * Integer value. - */ - integerValue?: number | null; - /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - */ - moneyValue?: Schema$GoogleTypeMoney; - /** - * 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. - */ - text?: string | null; - } - /** - * Relationship between Entities. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntityRelation { - /** - * Object entity id. - */ - objectId?: string | null; - /** - * Relationship description. - */ - relation?: string | null; - /** - * Subject entity id. - */ - subjectId?: string | null; - } - /** - * A page in a Document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPage { - /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageBlock[]; - /** - * A list of detected barcodes. - */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Physical dimension of the page. - */ - dimension?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDimension; - /** - * A list of visually detected form fields on the page. - */ - formFields?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageFormField[]; - /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. - */ - image?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImage; - /** - * Image quality scores. - */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores; - /** - * Layout for the page. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - */ - lines?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLine[]; - /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - */ - pageNumber?: number | null; - /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - */ - paragraphs?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageParagraph[]; - /** - * The history of this page. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * A list of visually detected symbols on the page. - */ - symbols?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageSymbol[]; - /** - * A list of visually detected tables on the page. - */ - tables?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTable[]; - /** - * A list of visually detected tokens on the page. - */ - tokens?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageToken[]; - /** - * Transformation matrices that were applied to the original document image to produce Page.image. - */ - transforms?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageMatrix[]; - /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - visualElements?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageVisualElement[]; - } - /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchor { - /** - * One or more references to visual page elements - */ - pageRefs?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef[]; - } - /** - * Represents a weak reference to a page element within a document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef { - /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta1BoundingPoly; - /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. - */ - layoutId?: string | null; - /** - * Optional. The type of the layout element that is being referenced if any. - */ - layoutType?: string | null; - /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. - */ - page?: string | null; - } - /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageBlock { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Block. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A detected barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode { - /** - * Detailed barcode information of the DetectedBarcode. - */ - barcode?: Schema$GoogleCloudDocumentaiV1beta1Barcode; - /** - * Layout for DetectedBarcode. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage { - /** - * Confidence of detected language. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - */ - languageCode?: string | null; - } - /** - * Dimension for the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDimension { - /** - * Page height. - */ - height?: number | null; - /** - * Dimension unit. - */ - unit?: string | null; - /** - * Page width. - */ - width?: number | null; - } - /** - * A form field detected on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageFormField { - /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - */ - correctedKeyText?: string | null; - /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - */ - correctedValueText?: string | null; - /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. - */ - fieldName?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * Layout for the FormField value. - */ - fieldValue?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * A list of detected languages for name together with confidence. - */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * A list of detected languages for value together with confidence. - */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` - */ - valueType?: string | null; - } - /** - * Rendered image contents for this page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImage { - /** - * Raw byte content of the image. - */ - content?: string | null; - /** - * Height of the image in pixels. - */ - height?: number | null; - /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - */ - mimeType?: string | null; - /** - * Width of the image in pixels. - */ - width?: number | null; - } - /** - * Image quality scores for the page image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores { - /** - * A list of detected defects. - */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[]; - /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. - */ - qualityScore?: number | null; - } - /** - * Image Quality Defects - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect { - /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - */ - confidence?: number | null; - /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` - */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout { - /** - * The bounding polygon for the Layout. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta1BoundingPoly; - /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Detected orientation for the Layout. - */ - orientation?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - } - /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageLine { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Line. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageMatrix { - /** - * Number of columns in the matrix. - */ - cols?: number | null; - /** - * The matrix data. - */ - data?: string | null; - /** - * Number of rows in the matrix. - */ - rows?: number | null; - /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - */ - type?: number | null; - } - /** - * A collection of lines that a human would perceive as a paragraph. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageParagraph { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Paragraph. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A detected symbol. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Symbol. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTable { - /** - * Body rows of the table. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Header rows of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[]; - /** - * Layout for Table. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this table. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A cell representation inside the table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for TableCell. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell[]; - } - /** - * A detected token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageToken { - /** - * Detected break at the end of a Token. - */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Token. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * Text style attributes. - */ - styleInfo?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo; - } - /** - * Detected break at the end of a Token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak { - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Font and other text style attributes. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Whether the text is bold (equivalent to font_weight is at least `700`). - */ - bold?: boolean | null; - /** - * Font size in points (`1` point is `¹⁄₇₂` inches). - */ - fontSize?: number | null; - /** - * Name or style of the font. - */ - fontType?: string | null; - /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - */ - fontWeight?: number | null; - /** - * Whether the text is handwritten. - */ - handwritten?: boolean | null; - /** - * Whether the text is italic. - */ - italic?: boolean | null; - /** - * Letter spacing in points. - */ - letterSpacing?: number | null; - /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - */ - pixelFontSize?: number | null; - /** - * Whether the text is in small caps. This feature is not supported yet. - */ - smallcaps?: boolean | null; - /** - * Whether the text is strikethrough. This feature is not supported yet. - */ - strikeout?: boolean | null; - /** - * Whether the text is a subscript. This feature is not supported yet. - */ - subscript?: boolean | null; - /** - * Whether the text is a superscript. This feature is not supported yet. - */ - superscript?: boolean | null; - /** - * Color of the text. - */ - textColor?: Schema$GoogleTypeColor; - /** - * Whether the text is underlined. - */ - underlined?: boolean | null; - } - /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageVisualElement { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for VisualElement. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * Type of the VisualElement. - */ - type?: string | null; - } - /** - * Structure to identify provenance relationships between annotations in different revisions. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance { - /** - * The Id of this operation. Needs to be unique within the scope of the revision. - */ - id?: number | null; - /** - * References to the original elements that are replaced. - */ - parents?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenanceParent[]; - /** - * The index of the revision that produced this element. - */ - revision?: number | null; - /** - * The type of provenance operation. - */ - type?: string | null; - } - /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentProvenanceParent { - /** - * The id of the parent provenance. - */ - id?: number | null; - /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - */ - index?: number | null; - /** - * The index of the index into current revision's parent_ids list. - */ - revision?: number | null; - } - /** - * Contains past or forward revisions of this document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentRevision { - /** - * If the change was made by a person specify the name or id of that person. - */ - agent?: string | null; - /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. - */ - createTime?: string | null; - /** - * Human Review information of this revision. - */ - humanReview?: Schema$GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview; - /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. - */ - id?: string | null; - /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. - */ - parent?: number[] | null; - /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. - */ - parentIds?: string[] | null; - /** - * If the annotation was made by processor identify the processor by its resource name. - */ - processor?: string | null; - } - /** - * Human Review information of the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview { - /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - */ - stateMessage?: string | null; - } - /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; - /** - * The 0-based index of this shard. - */ - shardIndex?: string | null; - /** - * The index of the first character in Document.text in the overall document global text. - */ - textOffset?: string | null; - } - /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentStyle { - /** - * Text background color. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Text color. - */ - color?: Schema$GoogleTypeColor; - /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - */ - fontFamily?: string | null; - /** - * Font size. - */ - fontSize?: Schema$GoogleCloudDocumentaiV1beta1DocumentStyleFontSize; - /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - */ - fontWeight?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - */ - textDecoration?: string | null; - /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentStyleFontSize { - /** - * Font size for the text. - */ - size?: number | null; - /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - */ - unit?: string | null; - } - /** - * Text reference indexing into the Document.text. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor { - /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - */ - content?: string | null; - /** - * The text segments from the Document.text. - */ - textSegments?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment[]; - } - /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment { - /** - * TextSegment half open end UTF-8 char index in the Document.text. - */ - endIndex?: string | null; - /** - * TextSegment start UTF-8 char index in the Document.text. - */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextChange { - /** - * The text that replaces the text identified in the `text_anchor`. - */ - changedText?: string | null; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance[]; - /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - } - /** - * The Google Cloud Storage location where the output file will be written to. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1GcsDestination { - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input file will be read from. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1GcsSource { - uri?: string | null; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1InputConfig { - /** - * The Google Cloud Storage location to read the input from. This must be a single file. - */ - gcsSource?: Schema$GoogleCloudDocumentaiV1beta1GcsSource; - /** - * Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. - */ - mimeType?: string | null; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Contains metadata for the BatchProcessDocuments operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1OperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * The state of the current batch processing. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. - */ - stateMessage?: string | null; - /** - * The last update time of the operation. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1OutputConfig { - /** - * The Google Cloud Storage location to write the output to. - */ - gcsDestination?: Schema$GoogleCloudDocumentaiV1beta1GcsDestination; - /** - * The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - */ - pagesPerShard?: number | null; - } - /** - * Response to a single document processing request. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1ProcessDocumentResponse { - /** - * Information about the input file. This is the same as the corresponding input config in the request. - */ - inputConfig?: Schema$GoogleCloudDocumentaiV1beta1InputConfig; - /** - * The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. - */ - outputConfig?: Schema$GoogleCloudDocumentaiV1beta1OutputConfig; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Encodes the detailed information of a barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2Barcode { - /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - */ - format?: string | null; - /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - */ - rawValue?: string | null; - /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. - */ - valueFormat?: string | null; - } - /** - * Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse { - /** - * Responses for each individual document. - */ - responses?: Schema$GoogleCloudDocumentaiV1beta2ProcessDocumentResponse[]; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta2NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudDocumentaiV1beta2Vertex[]; - } - /** - * 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$GoogleCloudDocumentaiV1beta2Document { - /** - * Document chunked based on chunking config. - */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocument; - /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - */ - content?: string | null; - /** - * Parsed layout of the document. - */ - documentLayout?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayout; - /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - */ - entities?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntity[]; - /** - * Placeholder. Relationship among Document.entities. - */ - entityRelations?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntityRelation[]; - /** - * Any error that occurred while processing this document. - */ - error?: Schema$GoogleRpcStatus; - /** - * Labels for this document. - */ - labels?: Schema$GoogleCloudDocumentaiV1beta2DocumentLabel[]; - /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - */ - mimeType?: string | null; - /** - * Visual page layout for the Document. - */ - pages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPage[]; - /** - * Placeholder. Revision history of this document. - */ - revisions?: Schema$GoogleCloudDocumentaiV1beta2DocumentRevision[]; - /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. - */ - shardInfo?: Schema$GoogleCloudDocumentaiV1beta2DocumentShardInfo; - /** - * Optional. UTF-8 encoded text in reading order from the document. - */ - text?: string | null; - /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. - */ - textChanges?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextChange[]; - /** - * Styles for the Document.text. - */ - textStyles?: Schema$GoogleCloudDocumentaiV1beta2DocumentStyle[]; - /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). - */ - uri?: string | null; - } - /** - * Represents the chunks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocument { - /** - * List of chunks. - */ - chunks?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk[]; - } - /** - * Represents a chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk { - /** - * ID of the chunk. - */ - chunkId?: string | null; - /** - * Text content of the chunk. - */ - content?: string | null; - /** - * Page footers associated with the chunk. - */ - pageFooters?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter[]; - /** - * Page headers associated with the chunk. - */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader[]; - /** - * Page span of the chunk. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Unused. - */ - sourceBlockIds?: string[] | null; - } - /** - * Represents the page footer associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter { - /** - * Page span of the footer. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Footer in text format. - */ - text?: string | null; - } - /** - * Represents the page header associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader { - /** - * Page span of the header. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Header in text format. - */ - text?: string | null; - } - /** - * Represents where the chunk starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan { - /** - * Page where chunk ends in the document. - */ - pageEnd?: number | null; - /** - * Page where chunk starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayout { - /** - * List of blocks in the document. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents a block. A block could be one of the various types (text, table, list) supported. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock { - /** - * ID of the block. - */ - blockId?: string | null; - /** - * Block consisting of list content/structure. - */ - listBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; - /** - * Page span of the block. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; - /** - * Block consisting of table content/structure. - */ - tableBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; - /** - * Block consisting of text content. - */ - textBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; - } - /** - * Represents a list type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { - /** - * List entries that constitute a list block. - */ - listEntries?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; - /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - */ - type?: string | null; - } - /** - * Represents an entry in the list. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { - /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents where the block starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { - /** - * Page where block ends in the document. - */ - pageEnd?: number | null; - /** - * Page where block starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents a table type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { - /** - * Body rows containing main table content. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - /** - * Table caption/title. - */ - caption?: string | null; - /** - * Header rows at the top of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - } - /** - * Represents a cell in a table row. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { - /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * Represents a row in a table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { - /** - * A table row is a list of table cells. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; - } - /** - * Represents a text type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { - /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * Text content stored in the block. - */ - text?: string | null; - /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. - */ - type?: string | null; - } - /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntity { - /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. - */ - id?: string | null; - /** - * Optional. Deprecated. Use `id` field instead. - */ - mentionId?: string | null; - /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - */ - mentionText?: string | null; - /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue; - /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. - */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchor; - /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - */ - properties?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntity[]; - /** - * Optional. The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * Optional. Whether the entity will be redacted for de-identification purposes. - */ - redacted?: boolean | null; - /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - /** - * Required. Entity type from a schema e.g. `Address`. - */ - type?: string | null; - } - /** - * Parsed and normalized entity value. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue { - /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - */ - addressValue?: Schema$GoogleTypePostalAddress; - /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. - */ - booleanValue?: boolean | null; - /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - */ - datetimeValue?: Schema$GoogleTypeDateTime; - /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - */ - dateValue?: Schema$GoogleTypeDate; - /** - * Float value. - */ - floatValue?: number | null; - /** - * Integer value. - */ - integerValue?: number | null; - /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - */ - moneyValue?: Schema$GoogleTypeMoney; - /** - * 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. - */ - text?: string | null; - } - /** - * Relationship between Entities. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntityRelation { - /** - * Object entity id. - */ - objectId?: string | null; - /** - * Relationship description. - */ - relation?: string | null; - /** - * Subject entity id. - */ - subjectId?: string | null; - } - /** - * Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentLabel { - /** - * Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id\}/locations/{location-id\}/models/{model-id\}` - */ - automlModel?: string | null; - /** - * Confidence score between 0 and 1 for label assignment. - */ - confidence?: number | null; - /** - * Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category. - */ - name?: string | null; - } - /** - * A page in a Document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPage { - /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageBlock[]; - /** - * A list of detected barcodes. - */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Physical dimension of the page. - */ - dimension?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDimension; - /** - * A list of visually detected form fields on the page. - */ - formFields?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageFormField[]; - /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. - */ - image?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImage; - /** - * Image quality scores. - */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores; - /** - * Layout for the page. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - */ - lines?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLine[]; - /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - */ - pageNumber?: number | null; - /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - */ - paragraphs?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageParagraph[]; - /** - * The history of this page. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * A list of visually detected symbols on the page. - */ - symbols?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageSymbol[]; - /** - * A list of visually detected tables on the page. - */ - tables?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTable[]; - /** - * A list of visually detected tokens on the page. - */ - tokens?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageToken[]; - /** - * Transformation matrices that were applied to the original document image to produce Page.image. - */ - transforms?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageMatrix[]; - /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - visualElements?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageVisualElement[]; - } - /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchor { - /** - * One or more references to visual page elements - */ - pageRefs?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef[]; - } - /** - * Represents a weak reference to a page element within a document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef { - /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta2BoundingPoly; - /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. - */ - layoutId?: string | null; - /** - * Optional. The type of the layout element that is being referenced if any. - */ - layoutType?: string | null; - /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. - */ - page?: string | null; - } - /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageBlock { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Block. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A detected barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode { - /** - * Detailed barcode information of the DetectedBarcode. - */ - barcode?: Schema$GoogleCloudDocumentaiV1beta2Barcode; - /** - * Layout for DetectedBarcode. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage { - /** - * Confidence of detected language. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - */ - languageCode?: string | null; - } - /** - * Dimension for the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDimension { - /** - * Page height. - */ - height?: number | null; - /** - * Dimension unit. - */ - unit?: string | null; - /** - * Page width. - */ - width?: number | null; - } - /** - * A form field detected on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageFormField { - /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - */ - correctedKeyText?: string | null; - /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - */ - correctedValueText?: string | null; - /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. - */ - fieldName?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * Layout for the FormField value. - */ - fieldValue?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * A list of detected languages for name together with confidence. - */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * A list of detected languages for value together with confidence. - */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` - */ - valueType?: string | null; - } - /** - * Rendered image contents for this page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImage { - /** - * Raw byte content of the image. - */ - content?: string | null; - /** - * Height of the image in pixels. - */ - height?: number | null; - /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - */ - mimeType?: string | null; - /** - * Width of the image in pixels. - */ - width?: number | null; - } - /** - * Image quality scores for the page image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores { - /** - * A list of detected defects. - */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[]; - /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. - */ - qualityScore?: number | null; - } - /** - * Image Quality Defects - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect { - /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - */ - confidence?: number | null; - /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` - */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout { - /** - * The bounding polygon for the Layout. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta2BoundingPoly; - /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Detected orientation for the Layout. - */ - orientation?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - } - /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageLine { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Line. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageMatrix { - /** - * Number of columns in the matrix. - */ - cols?: number | null; - /** - * The matrix data. - */ - data?: string | null; - /** - * Number of rows in the matrix. - */ - rows?: number | null; - /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - */ - type?: number | null; - } - /** - * A collection of lines that a human would perceive as a paragraph. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageParagraph { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Paragraph. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A detected symbol. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Symbol. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTable { - /** - * Body rows of the table. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Header rows of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[]; - /** - * Layout for Table. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this table. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A cell representation inside the table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for TableCell. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell[]; - } - /** - * A detected token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageToken { - /** - * Detected break at the end of a Token. - */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Token. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * Text style attributes. - */ - styleInfo?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo; - } - /** - * Detected break at the end of a Token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak { - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Font and other text style attributes. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Whether the text is bold (equivalent to font_weight is at least `700`). - */ - bold?: boolean | null; - /** - * Font size in points (`1` point is `¹⁄₇₂` inches). - */ - fontSize?: number | null; - /** - * Name or style of the font. - */ - fontType?: string | null; - /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - */ - fontWeight?: number | null; - /** - * Whether the text is handwritten. - */ - handwritten?: boolean | null; - /** - * Whether the text is italic. - */ - italic?: boolean | null; - /** - * Letter spacing in points. - */ - letterSpacing?: number | null; - /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - */ - pixelFontSize?: number | null; - /** - * Whether the text is in small caps. This feature is not supported yet. - */ - smallcaps?: boolean | null; - /** - * Whether the text is strikethrough. This feature is not supported yet. - */ - strikeout?: boolean | null; - /** - * Whether the text is a subscript. This feature is not supported yet. - */ - subscript?: boolean | null; - /** - * Whether the text is a superscript. This feature is not supported yet. - */ - superscript?: boolean | null; - /** - * Color of the text. - */ - textColor?: Schema$GoogleTypeColor; - /** - * Whether the text is underlined. - */ - underlined?: boolean | null; - } - /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageVisualElement { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for VisualElement. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * Type of the VisualElement. - */ - type?: string | null; - } - /** - * Structure to identify provenance relationships between annotations in different revisions. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance { - /** - * The Id of this operation. Needs to be unique within the scope of the revision. - */ - id?: number | null; - /** - * References to the original elements that are replaced. - */ - parents?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenanceParent[]; - /** - * The index of the revision that produced this element. - */ - revision?: number | null; - /** - * The type of provenance operation. - */ - type?: string | null; - } - /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentProvenanceParent { - /** - * The id of the parent provenance. - */ - id?: number | null; - /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - */ - index?: number | null; - /** - * The index of the index into current revision's parent_ids list. - */ - revision?: number | null; - } - /** - * Contains past or forward revisions of this document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentRevision { - /** - * If the change was made by a person specify the name or id of that person. - */ - agent?: string | null; - /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. - */ - createTime?: string | null; - /** - * Human Review information of this revision. - */ - humanReview?: Schema$GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview; - /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. - */ - id?: string | null; - /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. - */ - parent?: number[] | null; - /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. - */ - parentIds?: string[] | null; - /** - * If the annotation was made by processor identify the processor by its resource name. - */ - processor?: string | null; - } - /** - * Human Review information of the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview { - /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - */ - stateMessage?: string | null; - } - /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; - /** - * The 0-based index of this shard. - */ - shardIndex?: string | null; - /** - * The index of the first character in Document.text in the overall document global text. - */ - textOffset?: string | null; - } - /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentStyle { - /** - * Text background color. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Text color. - */ - color?: Schema$GoogleTypeColor; - /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - */ - fontFamily?: string | null; - /** - * Font size. - */ - fontSize?: Schema$GoogleCloudDocumentaiV1beta2DocumentStyleFontSize; - /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - */ - fontWeight?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - */ - textDecoration?: string | null; - /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentStyleFontSize { - /** - * Font size for the text. - */ - size?: number | null; - /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - */ - unit?: string | null; - } - /** - * Text reference indexing into the Document.text. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor { - /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - */ - content?: string | null; - /** - * The text segments from the Document.text. - */ - textSegments?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment[]; - } - /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment { - /** - * TextSegment half open end UTF-8 char index in the Document.text. - */ - endIndex?: string | null; - /** - * TextSegment start UTF-8 char index in the Document.text. - */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextChange { - /** - * The text that replaces the text identified in the `text_anchor`. - */ - changedText?: string | null; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance[]; - /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - } - /** - * The Google Cloud Storage location where the output file will be written to. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2GcsDestination { - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input file will be read from. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2GcsSource { - uri?: string | null; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2InputConfig { - /** - * Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method. - */ - contents?: string | null; - /** - * The Google Cloud Storage location to read the input from. This must be a single file. - */ - gcsSource?: Schema$GoogleCloudDocumentaiV1beta2GcsSource; - /** - * Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. - */ - mimeType?: string | null; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Contains metadata for the BatchProcessDocuments operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2OperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * The state of the current batch processing. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. - */ - stateMessage?: string | null; - /** - * The last update time of the operation. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2OutputConfig { - /** - * The Google Cloud Storage location to write the output to. - */ - gcsDestination?: Schema$GoogleCloudDocumentaiV1beta2GcsDestination; - /** - * The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - */ - pagesPerShard?: number | null; - } - /** - * Response to a single document processing request. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2ProcessDocumentResponse { - /** - * Information about the input file. This is the same as the corresponding input config in the request. - */ - inputConfig?: Schema$GoogleCloudDocumentaiV1beta2InputConfig; - /** - * The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. - */ - outputConfig?: Schema$GoogleCloudDocumentaiV1beta2OutputConfig; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } export interface Schema$GoogleCloudDocumentaiV1beta3BatchDeleteDocumentsMetadata { /** * The basic metadata of the long-running operation. diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index 25bbf796c3..5fb90ff134 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -805,2455 +805,6 @@ export namespace documentai_v1beta3 { * Response message for BatchProcessDocuments. */ export interface Schema$GoogleCloudDocumentaiV1BatchProcessResponse {} - /** - * Encodes the detailed information of a barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1Barcode { - /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - */ - format?: string | null; - /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - */ - rawValue?: string | null; - /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. - */ - valueFormat?: string | null; - } - /** - * Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1BatchProcessDocumentsResponse { - /** - * Responses for each individual document. - */ - responses?: Schema$GoogleCloudDocumentaiV1beta1ProcessDocumentResponse[]; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta1NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudDocumentaiV1beta1Vertex[]; - } - /** - * 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$GoogleCloudDocumentaiV1beta1Document { - /** - * Document chunked based on chunking config. - */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocument; - /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - */ - content?: string | null; - /** - * Parsed layout of the document. - */ - documentLayout?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayout; - /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - */ - entities?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntity[]; - /** - * Placeholder. Relationship among Document.entities. - */ - entityRelations?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntityRelation[]; - /** - * Any error that occurred while processing this document. - */ - error?: Schema$GoogleRpcStatus; - /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - */ - mimeType?: string | null; - /** - * Visual page layout for the Document. - */ - pages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPage[]; - /** - * Placeholder. Revision history of this document. - */ - revisions?: Schema$GoogleCloudDocumentaiV1beta1DocumentRevision[]; - /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. - */ - shardInfo?: Schema$GoogleCloudDocumentaiV1beta1DocumentShardInfo; - /** - * Optional. UTF-8 encoded text in reading order from the document. - */ - text?: string | null; - /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. - */ - textChanges?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextChange[]; - /** - * Styles for the Document.text. - */ - textStyles?: Schema$GoogleCloudDocumentaiV1beta1DocumentStyle[]; - /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). - */ - uri?: string | null; - } - /** - * Represents the chunks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocument { - /** - * List of chunks. - */ - chunks?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk[]; - } - /** - * Represents a chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunk { - /** - * ID of the chunk. - */ - chunkId?: string | null; - /** - * Text content of the chunk. - */ - content?: string | null; - /** - * Page footers associated with the chunk. - */ - pageFooters?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter[]; - /** - * Page headers associated with the chunk. - */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader[]; - /** - * Page span of the chunk. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Unused. - */ - sourceBlockIds?: string[] | null; - } - /** - * Represents the page footer associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageFooter { - /** - * Page span of the footer. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Footer in text format. - */ - text?: string | null; - } - /** - * Represents the page header associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageHeader { - /** - * Page span of the header. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Header in text format. - */ - text?: string | null; - } - /** - * Represents where the chunk starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentChunkedDocumentChunkChunkPageSpan { - /** - * Page where chunk ends in the document. - */ - pageEnd?: number | null; - /** - * Page where chunk starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayout { - /** - * List of blocks in the document. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents a block. A block could be one of the various types (text, table, list) supported. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock { - /** - * ID of the block. - */ - blockId?: string | null; - /** - * Block consisting of list content/structure. - */ - listBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; - /** - * Page span of the block. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; - /** - * Block consisting of table content/structure. - */ - tableBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; - /** - * Block consisting of text content. - */ - textBlock?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; - } - /** - * Represents a list type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { - /** - * List entries that constitute a list block. - */ - listEntries?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; - /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - */ - type?: string | null; - } - /** - * Represents an entry in the list. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { - /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents where the block starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { - /** - * Page where block ends in the document. - */ - pageEnd?: number | null; - /** - * Page where block starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents a table type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { - /** - * Body rows containing main table content. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - /** - * Table caption/title. - */ - caption?: string | null; - /** - * Header rows at the top of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - } - /** - * Represents a cell in a table row. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { - /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * Represents a row in a table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { - /** - * A table row is a list of table cells. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; - } - /** - * Represents a text type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { - /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * Text content stored in the block. - */ - text?: string | null; - /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. - */ - type?: string | null; - } - /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntity { - /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. - */ - id?: string | null; - /** - * Optional. Deprecated. Use `id` field instead. - */ - mentionId?: string | null; - /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - */ - mentionText?: string | null; - /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue; - /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. - */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchor; - /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - */ - properties?: Schema$GoogleCloudDocumentaiV1beta1DocumentEntity[]; - /** - * Optional. The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * Optional. Whether the entity will be redacted for de-identification purposes. - */ - redacted?: boolean | null; - /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - /** - * Required. Entity type from a schema e.g. `Address`. - */ - type?: string | null; - } - /** - * Parsed and normalized entity value. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntityNormalizedValue { - /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - */ - addressValue?: Schema$GoogleTypePostalAddress; - /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. - */ - booleanValue?: boolean | null; - /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - */ - datetimeValue?: Schema$GoogleTypeDateTime; - /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - */ - dateValue?: Schema$GoogleTypeDate; - /** - * Float value. - */ - floatValue?: number | null; - /** - * Integer value. - */ - integerValue?: number | null; - /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - */ - moneyValue?: Schema$GoogleTypeMoney; - /** - * 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. - */ - text?: string | null; - } - /** - * Relationship between Entities. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentEntityRelation { - /** - * Object entity id. - */ - objectId?: string | null; - /** - * Relationship description. - */ - relation?: string | null; - /** - * Subject entity id. - */ - subjectId?: string | null; - } - /** - * A page in a Document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPage { - /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageBlock[]; - /** - * A list of detected barcodes. - */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Physical dimension of the page. - */ - dimension?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDimension; - /** - * A list of visually detected form fields on the page. - */ - formFields?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageFormField[]; - /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. - */ - image?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImage; - /** - * Image quality scores. - */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores; - /** - * Layout for the page. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - */ - lines?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLine[]; - /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - */ - pageNumber?: number | null; - /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - */ - paragraphs?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageParagraph[]; - /** - * The history of this page. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * A list of visually detected symbols on the page. - */ - symbols?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageSymbol[]; - /** - * A list of visually detected tables on the page. - */ - tables?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTable[]; - /** - * A list of visually detected tokens on the page. - */ - tokens?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageToken[]; - /** - * Transformation matrices that were applied to the original document image to produce Page.image. - */ - transforms?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageMatrix[]; - /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - visualElements?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageVisualElement[]; - } - /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchor { - /** - * One or more references to visual page elements - */ - pageRefs?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef[]; - } - /** - * Represents a weak reference to a page element within a document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageAnchorPageRef { - /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta1BoundingPoly; - /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. - */ - layoutId?: string | null; - /** - * Optional. The type of the layout element that is being referenced if any. - */ - layoutType?: string | null; - /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. - */ - page?: string | null; - } - /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageBlock { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Block. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A detected barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedBarcode { - /** - * Detailed barcode information of the DetectedBarcode. - */ - barcode?: Schema$GoogleCloudDocumentaiV1beta1Barcode; - /** - * Layout for DetectedBarcode. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage { - /** - * Confidence of detected language. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - */ - languageCode?: string | null; - } - /** - * Dimension for the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageDimension { - /** - * Page height. - */ - height?: number | null; - /** - * Dimension unit. - */ - unit?: string | null; - /** - * Page width. - */ - width?: number | null; - } - /** - * A form field detected on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageFormField { - /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - */ - correctedKeyText?: string | null; - /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - */ - correctedValueText?: string | null; - /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. - */ - fieldName?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * Layout for the FormField value. - */ - fieldValue?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * A list of detected languages for name together with confidence. - */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * A list of detected languages for value together with confidence. - */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` - */ - valueType?: string | null; - } - /** - * Rendered image contents for this page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImage { - /** - * Raw byte content of the image. - */ - content?: string | null; - /** - * Height of the image in pixels. - */ - height?: number | null; - /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - */ - mimeType?: string | null; - /** - * Width of the image in pixels. - */ - width?: number | null; - } - /** - * Image quality scores for the page image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScores { - /** - * A list of detected defects. - */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect[]; - /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. - */ - qualityScore?: number | null; - } - /** - * Image Quality Defects - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageImageQualityScoresDetectedDefect { - /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - */ - confidence?: number | null; - /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` - */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout { - /** - * The bounding polygon for the Layout. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta1BoundingPoly; - /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Detected orientation for the Layout. - */ - orientation?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - } - /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageLine { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Line. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageMatrix { - /** - * Number of columns in the matrix. - */ - cols?: number | null; - /** - * The matrix data. - */ - data?: string | null; - /** - * Number of rows in the matrix. - */ - rows?: number | null; - /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - */ - type?: number | null; - } - /** - * A collection of lines that a human would perceive as a paragraph. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageParagraph { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Paragraph. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A detected symbol. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Symbol. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTable { - /** - * Body rows of the table. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Header rows of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow[]; - /** - * Layout for Table. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this table. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - } - /** - * A cell representation inside the table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for TableCell. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTableTableCell[]; - } - /** - * A detected token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageToken { - /** - * Detected break at the end of a Token. - */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for Token. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance; - /** - * Text style attributes. - */ - styleInfo?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo; - } - /** - * Detected break at the end of a Token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenDetectedBreak { - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Font and other text style attributes. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Whether the text is bold (equivalent to font_weight is at least `700`). - */ - bold?: boolean | null; - /** - * Font size in points (`1` point is `¹⁄₇₂` inches). - */ - fontSize?: number | null; - /** - * Name or style of the font. - */ - fontType?: string | null; - /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - */ - fontWeight?: number | null; - /** - * Whether the text is handwritten. - */ - handwritten?: boolean | null; - /** - * Whether the text is italic. - */ - italic?: boolean | null; - /** - * Letter spacing in points. - */ - letterSpacing?: number | null; - /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - */ - pixelFontSize?: number | null; - /** - * Whether the text is in small caps. This feature is not supported yet. - */ - smallcaps?: boolean | null; - /** - * Whether the text is strikethrough. This feature is not supported yet. - */ - strikeout?: boolean | null; - /** - * Whether the text is a subscript. This feature is not supported yet. - */ - subscript?: boolean | null; - /** - * Whether the text is a superscript. This feature is not supported yet. - */ - superscript?: boolean | null; - /** - * Color of the text. - */ - textColor?: Schema$GoogleTypeColor; - /** - * Whether the text is underlined. - */ - underlined?: boolean | null; - } - /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentPageVisualElement { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageDetectedLanguage[]; - /** - * Layout for VisualElement. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta1DocumentPageLayout; - /** - * Type of the VisualElement. - */ - type?: string | null; - } - /** - * Structure to identify provenance relationships between annotations in different revisions. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance { - /** - * The Id of this operation. Needs to be unique within the scope of the revision. - */ - id?: number | null; - /** - * References to the original elements that are replaced. - */ - parents?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenanceParent[]; - /** - * The index of the revision that produced this element. - */ - revision?: number | null; - /** - * The type of provenance operation. - */ - type?: string | null; - } - /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentProvenanceParent { - /** - * The id of the parent provenance. - */ - id?: number | null; - /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - */ - index?: number | null; - /** - * The index of the index into current revision's parent_ids list. - */ - revision?: number | null; - } - /** - * Contains past or forward revisions of this document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentRevision { - /** - * If the change was made by a person specify the name or id of that person. - */ - agent?: string | null; - /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. - */ - createTime?: string | null; - /** - * Human Review information of this revision. - */ - humanReview?: Schema$GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview; - /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. - */ - id?: string | null; - /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. - */ - parent?: number[] | null; - /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. - */ - parentIds?: string[] | null; - /** - * If the annotation was made by processor identify the processor by its resource name. - */ - processor?: string | null; - } - /** - * Human Review information of the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentRevisionHumanReview { - /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - */ - stateMessage?: string | null; - } - /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; - /** - * The 0-based index of this shard. - */ - shardIndex?: string | null; - /** - * The index of the first character in Document.text in the overall document global text. - */ - textOffset?: string | null; - } - /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentStyle { - /** - * Text background color. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Text color. - */ - color?: Schema$GoogleTypeColor; - /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - */ - fontFamily?: string | null; - /** - * Font size. - */ - fontSize?: Schema$GoogleCloudDocumentaiV1beta1DocumentStyleFontSize; - /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - */ - fontWeight?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - */ - textDecoration?: string | null; - /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentStyleFontSize { - /** - * Font size for the text. - */ - size?: number | null; - /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - */ - unit?: string | null; - } - /** - * Text reference indexing into the Document.text. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor { - /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - */ - content?: string | null; - /** - * The text segments from the Document.text. - */ - textSegments?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment[]; - } - /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchorTextSegment { - /** - * TextSegment half open end UTF-8 char index in the Document.text. - */ - endIndex?: string | null; - /** - * TextSegment start UTF-8 char index in the Document.text. - */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1DocumentTextChange { - /** - * The text that replaces the text identified in the `text_anchor`. - */ - changedText?: string | null; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta1DocumentProvenance[]; - /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta1DocumentTextAnchor; - } - /** - * The Google Cloud Storage location where the output file will be written to. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1GcsDestination { - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input file will be read from. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1GcsSource { - uri?: string | null; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1InputConfig { - /** - * The Google Cloud Storage location to read the input from. This must be a single file. - */ - gcsSource?: Schema$GoogleCloudDocumentaiV1beta1GcsSource; - /** - * Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. - */ - mimeType?: string | null; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Contains metadata for the BatchProcessDocuments operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1OperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * The state of the current batch processing. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. - */ - stateMessage?: string | null; - /** - * The last update time of the operation. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1OutputConfig { - /** - * The Google Cloud Storage location to write the output to. - */ - gcsDestination?: Schema$GoogleCloudDocumentaiV1beta1GcsDestination; - /** - * The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - */ - pagesPerShard?: number | null; - } - /** - * Response to a single document processing request. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1ProcessDocumentResponse { - /** - * Information about the input file. This is the same as the corresponding input config in the request. - */ - inputConfig?: Schema$GoogleCloudDocumentaiV1beta1InputConfig; - /** - * The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. - */ - outputConfig?: Schema$GoogleCloudDocumentaiV1beta1OutputConfig; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta1Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Encodes the detailed information of a barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2Barcode { - /** - * Format of a barcode. The supported formats are: - `CODE_128`: Code 128 type. - `CODE_39`: Code 39 type. - `CODE_93`: Code 93 type. - `CODABAR`: Codabar type. - `DATA_MATRIX`: 2D Data Matrix type. - `ITF`: ITF type. - `EAN_13`: EAN-13 type. - `EAN_8`: EAN-8 type. - `QR_CODE`: 2D QR code type. - `UPC_A`: UPC-A type. - `UPC_E`: UPC-E type. - `PDF417`: PDF417 type. - `AZTEC`: 2D Aztec code type. - `DATABAR`: GS1 DataBar code type. - */ - format?: string | null; - /** - * Raw value encoded in the barcode. For example: `'MEBKM:TITLE:Google;URL:https://www.google.com;;'`. - */ - rawValue?: string | null; - /** - * Value format describes the format of the value that a barcode encodes. The supported formats are: - `CONTACT_INFO`: Contact information. - `EMAIL`: Email address. - `ISBN`: ISBN identifier. - `PHONE`: Phone number. - `PRODUCT`: Product. - `SMS`: SMS message. - `TEXT`: Text string. - `URL`: URL address. - `WIFI`: Wifi information. - `GEO`: Geo-localization. - `CALENDAR_EVENT`: Calendar event. - `DRIVER_LICENSE`: Driver's license. - */ - valueFormat?: string | null; - } - /** - * Response to an batch document processing request. This is returned in the LRO Operation after the operation is complete. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2BatchProcessDocumentsResponse { - /** - * Responses for each individual document. - */ - responses?: Schema$GoogleCloudDocumentaiV1beta2ProcessDocumentResponse[]; - } - /** - * A bounding polygon for the detected image annotation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2BoundingPoly { - /** - * The bounding polygon normalized vertices. - */ - normalizedVertices?: Schema$GoogleCloudDocumentaiV1beta2NormalizedVertex[]; - /** - * The bounding polygon vertices. - */ - vertices?: Schema$GoogleCloudDocumentaiV1beta2Vertex[]; - } - /** - * 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$GoogleCloudDocumentaiV1beta2Document { - /** - * Document chunked based on chunking config. - */ - chunkedDocument?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocument; - /** - * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. - */ - content?: string | null; - /** - * Parsed layout of the document. - */ - documentLayout?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayout; - /** - * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. - */ - entities?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntity[]; - /** - * Placeholder. Relationship among Document.entities. - */ - entityRelations?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntityRelation[]; - /** - * Any error that occurred while processing this document. - */ - error?: Schema$GoogleRpcStatus; - /** - * Labels for this document. - */ - labels?: Schema$GoogleCloudDocumentaiV1beta2DocumentLabel[]; - /** - * An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml). - */ - mimeType?: string | null; - /** - * Visual page layout for the Document. - */ - pages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPage[]; - /** - * Placeholder. Revision history of this document. - */ - revisions?: Schema$GoogleCloudDocumentaiV1beta2DocumentRevision[]; - /** - * Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified. - */ - shardInfo?: Schema$GoogleCloudDocumentaiV1beta2DocumentShardInfo; - /** - * Optional. UTF-8 encoded text in reading order from the document. - */ - text?: string | null; - /** - * Placeholder. A list of text corrections made to Document.text. This is usually used for annotating corrections to OCR mistakes. Text changes for a given revision may not overlap with each other. - */ - textChanges?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextChange[]; - /** - * Styles for the Document.text. - */ - textStyles?: Schema$GoogleCloudDocumentaiV1beta2DocumentStyle[]; - /** - * Optional. Currently supports Google Cloud Storage URI of the form `gs://bucket_name/object_name`. Object versioning is not supported. For more information, refer to [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference-uris). - */ - uri?: string | null; - } - /** - * Represents the chunks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocument { - /** - * List of chunks. - */ - chunks?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk[]; - } - /** - * Represents a chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunk { - /** - * ID of the chunk. - */ - chunkId?: string | null; - /** - * Text content of the chunk. - */ - content?: string | null; - /** - * Page footers associated with the chunk. - */ - pageFooters?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter[]; - /** - * Page headers associated with the chunk. - */ - pageHeaders?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader[]; - /** - * Page span of the chunk. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Unused. - */ - sourceBlockIds?: string[] | null; - } - /** - * Represents the page footer associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageFooter { - /** - * Page span of the footer. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Footer in text format. - */ - text?: string | null; - } - /** - * Represents the page header associated with the chunk. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageHeader { - /** - * Page span of the header. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan; - /** - * Header in text format. - */ - text?: string | null; - } - /** - * Represents where the chunk starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentChunkedDocumentChunkChunkPageSpan { - /** - * Page where chunk ends in the document. - */ - pageEnd?: number | null; - /** - * Page where chunk starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents the parsed layout of a document as a collection of blocks that the document is divided into. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayout { - /** - * List of blocks in the document. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents a block. A block could be one of the various types (text, table, list) supported. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock { - /** - * ID of the block. - */ - blockId?: string | null; - /** - * Block consisting of list content/structure. - */ - listBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; - /** - * Page span of the block. - */ - pageSpan?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; - /** - * Block consisting of table content/structure. - */ - tableBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; - /** - * Block consisting of text content. - */ - textBlock?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; - } - /** - * Represents a list type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { - /** - * List entries that constitute a list block. - */ - listEntries?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; - /** - * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. - */ - type?: string | null; - } - /** - * Represents an entry in the list. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { - /** - * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - } - /** - * Represents where the block starts and ends in the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { - /** - * Page where block ends in the document. - */ - pageEnd?: number | null; - /** - * Page where block starts in the document. - */ - pageStart?: number | null; - } - /** - * Represents a table type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { - /** - * Body rows containing main table content. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - /** - * Table caption/title. - */ - caption?: string | null; - /** - * Header rows at the top of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; - } - /** - * Represents a cell in a table row. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { - /** - * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * Represents a row in a table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { - /** - * A table row is a list of table cells. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; - } - /** - * Represents a text type block. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { - /** - * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentDocumentLayoutDocumentLayoutBlock[]; - /** - * Text content stored in the block. - */ - text?: string | null; - /** - * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. - */ - type?: string | null; - } - /** - * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntity { - /** - * Optional. Confidence of detected Schema entity. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Canonical id. This will be a unique value in the entity list for this document. - */ - id?: string | null; - /** - * Optional. Deprecated. Use `id` field instead. - */ - mentionId?: string | null; - /** - * Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`. - */ - mentionText?: string | null; - /** - * Optional. Normalized entity value. Absent if the extracted value could not be converted or the type (e.g. address) is not supported for certain parsers. This field is also only populated for certain supported document types. - */ - normalizedValue?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue; - /** - * Optional. Represents the provenance of this entity wrt. the location on the page where it was found. - */ - pageAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchor; - /** - * Optional. Entities can be nested to form a hierarchical data structure representing the content in the document. - */ - properties?: Schema$GoogleCloudDocumentaiV1beta2DocumentEntity[]; - /** - * Optional. The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * Optional. Whether the entity will be redacted for de-identification purposes. - */ - redacted?: boolean | null; - /** - * Optional. Provenance of the entity. Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - /** - * Required. Entity type from a schema e.g. `Address`. - */ - type?: string | null; - } - /** - * Parsed and normalized entity value. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntityNormalizedValue { - /** - * Postal address. See also: https://github.com/googleapis/googleapis/blob/master/google/type/postal_address.proto - */ - addressValue?: Schema$GoogleTypePostalAddress; - /** - * Boolean value. Can be used for entities with binary values, or for checkboxes. - */ - booleanValue?: boolean | null; - /** - * DateTime value. Includes date, time, and timezone. See also: https://github.com/googleapis/googleapis/blob/master/google/type/datetime.proto - */ - datetimeValue?: Schema$GoogleTypeDateTime; - /** - * Date value. Includes year, month, day. See also: https://github.com/googleapis/googleapis/blob/master/google/type/date.proto - */ - dateValue?: Schema$GoogleTypeDate; - /** - * Float value. - */ - floatValue?: number | null; - /** - * Integer value. - */ - integerValue?: number | null; - /** - * Money value. See also: https://github.com/googleapis/googleapis/blob/master/google/type/money.proto - */ - moneyValue?: Schema$GoogleTypeMoney; - /** - * 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. - */ - text?: string | null; - } - /** - * Relationship between Entities. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentEntityRelation { - /** - * Object entity id. - */ - objectId?: string | null; - /** - * Relationship description. - */ - relation?: string | null; - /** - * Subject entity id. - */ - subjectId?: string | null; - } - /** - * Label attaches schema information and/or other metadata to segments within a Document. Multiple Labels on a single field can denote either different labels, different instances of the same label created at different times, or some combination of both. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentLabel { - /** - * Label is generated AutoML model. This field stores the full resource name of the AutoML model. Format: `projects/{project-id\}/locations/{location-id\}/models/{model-id\}` - */ - automlModel?: string | null; - /** - * Confidence score between 0 and 1 for label assignment. - */ - confidence?: number | null; - /** - * Name of the label. When the label is generated from AutoML Text Classification model, this field represents the name of the category. - */ - name?: string | null; - } - /** - * A page in a Document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPage { - /** - * A list of visually detected text blocks on the page. A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - blocks?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageBlock[]; - /** - * A list of detected barcodes. - */ - detectedBarcodes?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Physical dimension of the page. - */ - dimension?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDimension; - /** - * A list of visually detected form fields on the page. - */ - formFields?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageFormField[]; - /** - * Rendered image for this page. This image is preprocessed to remove any skew, rotation, and distortions such that the annotation bounding boxes can be upright and axis-aligned. - */ - image?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImage; - /** - * Image quality scores. - */ - imageQualityScores?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores; - /** - * Layout for the page. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * A list of visually detected text lines on the page. A collection of tokens that a human would perceive as a line. - */ - lines?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLine[]; - /** - * 1-based index for current Page in a parent Document. Useful when a page is taken out of a Document for individual processing. - */ - pageNumber?: number | null; - /** - * A list of visually detected text paragraphs on the page. A collection of lines that a human would perceive as a paragraph. - */ - paragraphs?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageParagraph[]; - /** - * The history of this page. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * A list of visually detected symbols on the page. - */ - symbols?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageSymbol[]; - /** - * A list of visually detected tables on the page. - */ - tables?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTable[]; - /** - * A list of visually detected tokens on the page. - */ - tokens?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageToken[]; - /** - * Transformation matrices that were applied to the original document image to produce Page.image. - */ - transforms?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageMatrix[]; - /** - * A list of detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - visualElements?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageVisualElement[]; - } - /** - * Referencing the visual context of the entity in the Document.pages. Page anchors can be cross-page, consist of multiple bounding polygons and optionally reference specific layout element types. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchor { - /** - * One or more references to visual page elements - */ - pageRefs?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef[]; - } - /** - * Represents a weak reference to a page element within a document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageAnchorPageRef { - /** - * Optional. Identifies the bounding polygon of a layout element on the page. If `layout_type` is set, the bounding polygon must be exactly the same to the layout element it's referring to. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta2BoundingPoly; - /** - * Optional. Confidence of detected page element, if applicable. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Optional. Deprecated. Use PageRef.bounding_poly instead. - */ - layoutId?: string | null; - /** - * Optional. The type of the layout element that is being referenced if any. - */ - layoutType?: string | null; - /** - * Required. Index into the Document.pages element, for example using `Document.pages` to locate the related page element. This field is skipped when its value is the default `0`. See https://developers.google.com/protocol-buffers/docs/proto3#json. - */ - page?: string | null; - } - /** - * A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageBlock { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Block. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A detected barcode. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedBarcode { - /** - * Detailed barcode information of the DetectedBarcode. - */ - barcode?: Schema$GoogleCloudDocumentaiV1beta2Barcode; - /** - * Layout for DetectedBarcode. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - } - /** - * Detected language for a structural component. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage { - /** - * Confidence of detected language. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * The [BCP-47 language code](https://www.unicode.org/reports/tr35/#Unicode_locale_identifier), such as `en-US` or `sr-Latn`. - */ - languageCode?: string | null; - } - /** - * Dimension for the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageDimension { - /** - * Page height. - */ - height?: number | null; - /** - * Dimension unit. - */ - unit?: string | null; - /** - * Page width. - */ - width?: number | null; - } - /** - * A form field detected on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageFormField { - /** - * Created for Labeling UI to export key text. If corrections were made to the text identified by the `field_name.text_anchor`, this field will contain the correction. - */ - correctedKeyText?: string | null; - /** - * Created for Labeling UI to export value text. If corrections were made to the text identified by the `field_value.text_anchor`, this field will contain the correction. - */ - correctedValueText?: string | null; - /** - * Layout for the FormField name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc. - */ - fieldName?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * Layout for the FormField value. - */ - fieldValue?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * A list of detected languages for name together with confidence. - */ - nameDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * A list of detected languages for value together with confidence. - */ - valueDetectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * If the value is non-textual, this field represents the type. Current valid values are: - blank (this indicates the `field_value` is normal text) - `unfilled_checkbox` - `filled_checkbox` - */ - valueType?: string | null; - } - /** - * Rendered image contents for this page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImage { - /** - * Raw byte content of the image. - */ - content?: string | null; - /** - * Height of the image in pixels. - */ - height?: number | null; - /** - * Encoding [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml) for the image. - */ - mimeType?: string | null; - /** - * Width of the image in pixels. - */ - width?: number | null; - } - /** - * Image quality scores for the page image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScores { - /** - * A list of detected defects. - */ - detectedDefects?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect[]; - /** - * The overall quality score. Range `[0, 1]` where `1` is perfect quality. - */ - qualityScore?: number | null; - } - /** - * Image Quality Defects - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageImageQualityScoresDetectedDefect { - /** - * Confidence of detected defect. Range `[0, 1]` where `1` indicates strong confidence that the defect exists. - */ - confidence?: number | null; - /** - * Name of the defect type. Supported values are: - `quality/defect_blurry` - `quality/defect_noisy` - `quality/defect_dark` - `quality/defect_faint` - `quality/defect_text_too_small` - `quality/defect_document_cutoff` - `quality/defect_text_cutoff` - `quality/defect_glare` - */ - type?: string | null; - } - /** - * Visual element describing a layout unit on a page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout { - /** - * The bounding polygon for the Layout. - */ - boundingPoly?: Schema$GoogleCloudDocumentaiV1beta2BoundingPoly; - /** - * Confidence of the current Layout within context of the object this layout is for. e.g. confidence can be for a single token, a table, a visual element, etc. depending on context. Range `[0, 1]`. - */ - confidence?: number | null; - /** - * Detected orientation for the Layout. - */ - orientation?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - } - /** - * A collection of tokens that a human would perceive as a line. Does not cross column boundaries, can be horizontal, vertical, etc. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageLine { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Line. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * Representation for transformation matrix, intended to be compatible and used with OpenCV format for image manipulation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageMatrix { - /** - * Number of columns in the matrix. - */ - cols?: number | null; - /** - * The matrix data. - */ - data?: string | null; - /** - * Number of rows in the matrix. - */ - rows?: number | null; - /** - * This encodes information about what data type the matrix uses. For example, 0 (CV_8U) is an unsigned 8-bit image. For the full list of OpenCV primitive data types, please refer to https://docs.opencv.org/4.3.0/d1/d1b/group__core__hal__interface.html - */ - type?: number | null; - } - /** - * A collection of lines that a human would perceive as a paragraph. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageParagraph { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Paragraph. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A detected symbol. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageSymbol { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Symbol. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - } - /** - * A table representation similar to HTML table structure. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTable { - /** - * Body rows of the table. - */ - bodyRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[]; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Header rows of the table. - */ - headerRows?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow[]; - /** - * Layout for Table. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this table. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - } - /** - * A cell representation inside the table. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell { - /** - * How many columns this cell spans. - */ - colSpan?: number | null; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for TableCell. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * How many rows this cell spans. - */ - rowSpan?: number | null; - } - /** - * A row of table cells. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableRow { - /** - * Cells that make up this row. - */ - cells?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTableTableCell[]; - } - /** - * A detected token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageToken { - /** - * Detected break at the end of a Token. - */ - detectedBreak?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak; - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for Token. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance; - /** - * Text style attributes. - */ - styleInfo?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo; - } - /** - * Detected break at the end of a Token. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenDetectedBreak { - /** - * Detected break type. - */ - type?: string | null; - } - /** - * Font and other text style attributes. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageTokenStyleInfo { - /** - * Color of the background. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Whether the text is bold (equivalent to font_weight is at least `700`). - */ - bold?: boolean | null; - /** - * Font size in points (`1` point is `¹⁄₇₂` inches). - */ - fontSize?: number | null; - /** - * Name or style of the font. - */ - fontType?: string | null; - /** - * TrueType weight on a scale `100` (thin) to `1000` (ultra-heavy). Normal is `400`, bold is `700`. - */ - fontWeight?: number | null; - /** - * Whether the text is handwritten. - */ - handwritten?: boolean | null; - /** - * Whether the text is italic. - */ - italic?: boolean | null; - /** - * Letter spacing in points. - */ - letterSpacing?: number | null; - /** - * Font size in pixels, equal to _unrounded font_size_ * _resolution_ ÷ `72.0`. - */ - pixelFontSize?: number | null; - /** - * Whether the text is in small caps. This feature is not supported yet. - */ - smallcaps?: boolean | null; - /** - * Whether the text is strikethrough. This feature is not supported yet. - */ - strikeout?: boolean | null; - /** - * Whether the text is a subscript. This feature is not supported yet. - */ - subscript?: boolean | null; - /** - * Whether the text is a superscript. This feature is not supported yet. - */ - superscript?: boolean | null; - /** - * Color of the text. - */ - textColor?: Schema$GoogleTypeColor; - /** - * Whether the text is underlined. - */ - underlined?: boolean | null; - } - /** - * Detected non-text visual elements e.g. checkbox, signature etc. on the page. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentPageVisualElement { - /** - * A list of detected languages together with confidence. - */ - detectedLanguages?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageDetectedLanguage[]; - /** - * Layout for VisualElement. - */ - layout?: Schema$GoogleCloudDocumentaiV1beta2DocumentPageLayout; - /** - * Type of the VisualElement. - */ - type?: string | null; - } - /** - * Structure to identify provenance relationships between annotations in different revisions. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance { - /** - * The Id of this operation. Needs to be unique within the scope of the revision. - */ - id?: number | null; - /** - * References to the original elements that are replaced. - */ - parents?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenanceParent[]; - /** - * The index of the revision that produced this element. - */ - revision?: number | null; - /** - * The type of provenance operation. - */ - type?: string | null; - } - /** - * The parent element the current element is based on. Used for referencing/aligning, removal and replacement operations. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentProvenanceParent { - /** - * The id of the parent provenance. - */ - id?: number | null; - /** - * The index of the parent item in the corresponding item list (eg. list of entities, properties within entities, etc.) in the parent revision. - */ - index?: number | null; - /** - * The index of the index into current revision's parent_ids list. - */ - revision?: number | null; - } - /** - * Contains past or forward revisions of this document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentRevision { - /** - * If the change was made by a person specify the name or id of that person. - */ - agent?: string | null; - /** - * The time that the revision was created, internally generated by doc proto storage at the time of create. - */ - createTime?: string | null; - /** - * Human Review information of this revision. - */ - humanReview?: Schema$GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview; - /** - * Id of the revision, internally generated by doc proto storage. Unique within the context of the document. - */ - id?: string | null; - /** - * The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the `revisions` field. - */ - parent?: number[] | null; - /** - * The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are `provenance.parent.revision` fields that index into this field. - */ - parentIds?: string[] | null; - /** - * If the annotation was made by processor identify the processor by its resource name. - */ - processor?: string | null; - } - /** - * Human Review information of the document. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentRevisionHumanReview { - /** - * Human review state. e.g. `requested`, `succeeded`, `rejected`. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. For example, the rejection reason when the state is `rejected`. - */ - stateMessage?: string | null; - } - /** - * For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentShardInfo { - /** - * Total number of shards. - */ - shardCount?: string | null; - /** - * The 0-based index of this shard. - */ - shardIndex?: string | null; - /** - * The index of the first character in Document.text in the overall document global text. - */ - textOffset?: string | null; - } - /** - * Annotation for common text style attributes. This adheres to CSS conventions as much as possible. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentStyle { - /** - * Text background color. - */ - backgroundColor?: Schema$GoogleTypeColor; - /** - * Text color. - */ - color?: Schema$GoogleTypeColor; - /** - * Font family such as `Arial`, `Times New Roman`. https://www.w3schools.com/cssref/pr_font_font-family.asp - */ - fontFamily?: string | null; - /** - * Font size. - */ - fontSize?: Schema$GoogleCloudDocumentaiV1beta2DocumentStyleFontSize; - /** - * [Font weight](https://www.w3schools.com/cssref/pr_font_weight.asp). Possible values are `normal`, `bold`, `bolder`, and `lighter`. - */ - fontWeight?: string | null; - /** - * Text anchor indexing into the Document.text. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - /** - * [Text decoration](https://www.w3schools.com/cssref/pr_text_text-decoration.asp). Follows CSS standard. - */ - textDecoration?: string | null; - /** - * [Text style](https://www.w3schools.com/cssref/pr_font_font-style.asp). Possible values are `normal`, `italic`, and `oblique`. - */ - textStyle?: string | null; - } - /** - * Font size with unit. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentStyleFontSize { - /** - * Font size for the text. - */ - size?: number | null; - /** - * Unit for the font size. Follows CSS naming (such as `in`, `px`, and `pt`). - */ - unit?: string | null; - } - /** - * Text reference indexing into the Document.text. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor { - /** - * Contains the content of the text span so that users do not have to look it up in the text_segments. It is always populated for formFields. - */ - content?: string | null; - /** - * The text segments from the Document.text. - */ - textSegments?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment[]; - } - /** - * A text segment in the Document.text. The indices may be out of bounds which indicate that the text extends into another document shard for large sharded documents. See ShardInfo.text_offset - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchorTextSegment { - /** - * TextSegment half open end UTF-8 char index in the Document.text. - */ - endIndex?: string | null; - /** - * TextSegment start UTF-8 char index in the Document.text. - */ - startIndex?: string | null; - } - /** - * This message is used for text changes aka. OCR corrections. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2DocumentTextChange { - /** - * The text that replaces the text identified in the `text_anchor`. - */ - changedText?: string | null; - /** - * The history of this annotation. - */ - provenance?: Schema$GoogleCloudDocumentaiV1beta2DocumentProvenance[]; - /** - * Provenance of the correction. Text anchor indexing into the Document.text. There can only be a single `TextAnchor.text_segments` element. If the start and end index of the text segment are the same, the text change is inserted before that index. - */ - textAnchor?: Schema$GoogleCloudDocumentaiV1beta2DocumentTextAnchor; - } - /** - * The Google Cloud Storage location where the output file will be written to. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2GcsDestination { - uri?: string | null; - } - /** - * The Google Cloud Storage location where the input file will be read from. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2GcsSource { - uri?: string | null; - } - /** - * The desired input location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2InputConfig { - /** - * Content in bytes, represented as a stream of bytes. Note: As with all `bytes` fields, proto buffer messages use a pure binary representation, whereas JSON representations use base64. This field only works for synchronous ProcessDocument method. - */ - contents?: string | null; - /** - * The Google Cloud Storage location to read the input from. This must be a single file. - */ - gcsSource?: Schema$GoogleCloudDocumentaiV1beta2GcsSource; - /** - * Required. Mimetype of the input. Current supported mimetypes are application/pdf, image/tiff, and image/gif. In addition, application/json type is supported for requests with ProcessDocumentRequest.automl_params field set. The JSON file needs to be in Document format. - */ - mimeType?: string | null; - } - /** - * A vertex represents a 2D point in the image. NOTE: the normalized vertex coordinates are relative to the original image and range from 0 to 1. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2NormalizedVertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } - /** - * Contains metadata for the BatchProcessDocuments operation. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2OperationMetadata { - /** - * The creation time of the operation. - */ - createTime?: string | null; - /** - * The state of the current batch processing. - */ - state?: string | null; - /** - * A message providing more details about the current state of processing. - */ - stateMessage?: string | null; - /** - * The last update time of the operation. - */ - updateTime?: string | null; - } - /** - * The desired output location and metadata. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2OutputConfig { - /** - * The Google Cloud Storage location to write the output to. - */ - gcsDestination?: Schema$GoogleCloudDocumentaiV1beta2GcsDestination; - /** - * The max number of pages to include into each output Document shard JSON on Google Cloud Storage. The valid range is [1, 100]. If not specified, the default value is 20. For example, for one pdf file with 100 pages, 100 parsed pages will be produced. If `pages_per_shard` = 20, then 5 Document shard JSON files each containing 20 parsed pages will be written under the prefix OutputConfig.gcs_destination.uri and suffix pages-x-to-y.json where x and y are 1-indexed page numbers. Example GCS outputs with 157 pages and pages_per_shard = 50: pages-001-to-050.json pages-051-to-100.json pages-101-to-150.json pages-151-to-157.json - */ - pagesPerShard?: number | null; - } - /** - * Response to a single document processing request. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2ProcessDocumentResponse { - /** - * Information about the input file. This is the same as the corresponding input config in the request. - */ - inputConfig?: Schema$GoogleCloudDocumentaiV1beta2InputConfig; - /** - * The output location of the parsed responses. The responses are written to this location as JSON-serialized `Document` objects. - */ - outputConfig?: Schema$GoogleCloudDocumentaiV1beta2OutputConfig; - } - /** - * A vertex represents a 2D point in the image. NOTE: the vertex coordinates are in the same scale as the original image. - */ - export interface Schema$GoogleCloudDocumentaiV1beta2Vertex { - /** - * X coordinate. - */ - x?: number | null; - /** - * Y coordinate (starts from the top of the image). - */ - y?: number | null; - } /** * Encodes the detailed information of a barcode. */ @@ -4723,6 +2274,10 @@ export namespace documentai_v1beta3 { * The entity type that this type is derived from. For now, one and only one should be set. */ baseTypes?: string[] | null; + /** + * The description of the entity type. Could be used to provide more information about the entity type for model calls. + */ + description?: string | null; /** * User defined name for the type. */ @@ -4757,6 +2312,10 @@ export namespace documentai_v1beta3 { * Defines properties that can be part of the entity type. */ export interface Schema$GoogleCloudDocumentaiV1beta3DocumentSchemaEntityTypeProperty { + /** + * The description of the property. Could be used to provide more information about the property for model calls. + */ + description?: string | null; /** * User defined name for the property. */ diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 6de564c9ee..9504458cfe 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -6268,7 +6268,7 @@ export namespace drive_v2 { */ maxResults?: number; /** - * A comma-separated list of sort keys. Valid keys are `createdDate`, `folder`, `lastViewedByMeDate`, `modifiedByMeDate`, `modifiedDate`, `quotaBytesUsed`, `recency`, `sharedWithMeDate`, `starred`, `title`, and `title_natural`. Each key sorts ascending by default, but may be reversed with the `desc` modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored. + * A comma-separated list of sort keys. Valid keys are: * `createdDate`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `lastViewedByMeDate`: The last time the file was viewed by the user. * `modifiedByMeDate`: The last time the file was modified by the user. * `modifiedDate`: The last time the file was modified by anyone. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeDate`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `title`: The title of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `title_natural`: The title of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedDate desc,title`. Note that there's a current limitation for users with approximately one million files in which the requested sort order is ignored. */ orderBy?: string; /** diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 10dc727a90..8bc33c10af 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -119,6 +119,8 @@ export namespace drive_v3 { comments: Resource$Comments; drives: Resource$Drives; files: Resource$Files; + operation: Resource$Operation; + operations: Resource$Operations; permissions: Resource$Permissions; replies: Resource$Replies; revisions: Resource$Revisions; @@ -137,6 +139,8 @@ export namespace drive_v3 { this.comments = new Resource$Comments(this.context); this.drives = new Resource$Drives(this.context); this.files = new Resource$Files(this.context); + this.operation = new Resource$Operation(this.context); + this.operations = new Resource$Operations(this.context); this.permissions = new Resource$Permissions(this.context); this.replies = new Resource$Replies(this.context); this.revisions = new Resource$Revisions(this.context); @@ -1174,6 +1178,19 @@ export namespace drive_v3 { */ removeLabel?: boolean | 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 request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically. */ @@ -1200,6 +1217,31 @@ export namespace drive_v3 { */ modifiedLabels?: Schema$Label[]; } + /** + * 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; + } /** * A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. 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. */ @@ -1438,6 +1480,23 @@ export namespace drive_v3 { */ startPageToken?: 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; + } /** * Deprecated: use the drive collection instead. */ @@ -3832,6 +3891,93 @@ export namespace drive_v3 { } } + /** + * Downloads content of a file. Operations are valid for 24 hours from the time of creation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + download( + params: Params$Resource$Files$Download, + options: StreamMethodOptions + ): GaxiosPromise; + download( + params?: Params$Resource$Files$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Files$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Files$Download, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Files$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Files$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Files$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Files$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files/{fileId}/download').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Permanently deletes all of the user's trashed files. * @@ -4741,6 +4887,20 @@ export namespace drive_v3 { */ supportsTeamDrives?: boolean; } + export interface Params$Resource$Files$Download extends StandardParameters { + /** + * Required. The ID of the file to download. + */ + fileId?: string; + /** + * Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. See [Export MIME types for Google Workspace documents](/drive/api/guides/ref-export-formats) for the list of supported MIME types. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future. + */ + mimeType?: string; + /** + * Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns `INVALID_ARGUMENT` if downloading a specific revision on the file is unsupported. + */ + revisionId?: string; + } export interface Params$Resource$Files$Emptytrash extends StandardParameters { /** * If set, empties the trash of the provided shared drive. @@ -4832,7 +4992,7 @@ export namespace drive_v3 { */ includeTeamDriveItems?: boolean; /** - * A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. + * A comma-separated list of sort keys. Valid keys are: * `createdTime`: When the file was created. * `folder`: The folder ID. This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The last time the file was modified by the user. * `modifiedTime`: The last time the file was modified by anyone. * `name`: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the file. * `recency`: The most recent timestamp from the file's date-time fields. * `sharedWithMeTime`: When the file was shared with the user, if applicable. * `starred`: Whether the user has starred the file. * `viewedByMeTime`: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the 'desc' modifier. Example usage: `?orderBy=folder,modifiedTime desc,name`. */ orderBy?: string; /** @@ -4988,6 +5148,407 @@ export namespace drive_v3 { requestBody?: Schema$Channel; } + export class Resource$Operation { + 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$Operation$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Operation$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Operation$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Operation$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Operation$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Operation$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operation$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operation$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/operation/{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$Operation$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Operation$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Operation$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operation$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Operation$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Operation$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operation$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operation$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/operation/{name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Operation$Cancel extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Operation$Delete extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + + export class Resource$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/operations/{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$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/operations').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$Operations$Get extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$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$Permissions { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index fc88a0234f..3595e7ac97 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -808,7 +808,11 @@ export namespace eventarc_v1 { context: APIRequestContext; channelConnections: Resource$Projects$Locations$Channelconnections; channels: Resource$Projects$Locations$Channels; + enrollments: Resource$Projects$Locations$Enrollments; + googleApiSources: Resource$Projects$Locations$Googleapisources; + messageBuses: Resource$Projects$Locations$Messagebuses; operations: Resource$Projects$Locations$Operations; + pipelines: Resource$Projects$Locations$Pipelines; providers: Resource$Projects$Locations$Providers; triggers: Resource$Projects$Locations$Triggers; constructor(context: APIRequestContext) { @@ -816,9 +820,19 @@ export namespace eventarc_v1 { this.channelConnections = new Resource$Projects$Locations$Channelconnections(this.context); this.channels = new Resource$Projects$Locations$Channels(this.context); + this.enrollments = new Resource$Projects$Locations$Enrollments( + this.context + ); + this.googleApiSources = new Resource$Projects$Locations$Googleapisources( + this.context + ); + this.messageBuses = new Resource$Projects$Locations$Messagebuses( + this.context + ); this.operations = new Resource$Projects$Locations$Operations( this.context ); + this.pipelines = new Resource$Projects$Locations$Pipelines(this.context); this.providers = new Resource$Projects$Locations$Providers(this.context); this.triggers = new Resource$Projects$Locations$Triggers(this.context); } @@ -2821,64 +2835,65 @@ export namespace eventarc_v1 { requestBody?: Schema$TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Enrollments { 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$Operations$Cancel, + getIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Enrollments$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Getiampolicy, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Enrollments$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$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Enrollments$Getiampolicy; 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$Enrollments$Getiampolicy; options = {}; } @@ -2891,79 +2906,83 @@ export namespace eventarc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Enrollments$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Enrollments$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Enrollments$Setiampolicy + | 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$Enrollments$Setiampolicy; 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$Enrollments$Setiampolicy; options = {}; } @@ -2976,86 +2995,90 @@ export namespace eventarc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Enrollments$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Enrollments$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Enrollments$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Enrollments$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Enrollments$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Enrollments$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Enrollments$Testiampermissions; 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$Enrollments$Testiampermissions; options = {}; } @@ -3068,86 +3091,311 @@ export namespace eventarc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Enrollments$Getiampolicy + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * 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$Enrollments$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$Enrollments$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$Googleapisources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + getIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Googleapisources$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Getiampolicy, 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 + getIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Getiampolicy, + callback: BodyResponseCallback ): void; - list( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Googleapisources$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Googleapisources$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Googleapisources$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Googleapisources$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Googleapisources$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Googleapisources$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Googleapisources$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Googleapisources$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.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$Googleapisources$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Googleapisources$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Googleapisources$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Googleapisources$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Googleapisources$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Googleapisources$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Googleapisources$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Googleapisources$Testiampermissions; options = {}; } @@ -3160,77 +3408,1111 @@ export namespace eventarc_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Googleapisources$Getiampolicy extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * 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; /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + resource?: string; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Googleapisources$Setiampolicy extends StandardParameters { /** - * The name of the operation resource to be deleted. + * 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; - } - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { + resource?: string; + /** - * The name of the operation resource. + * Request body metadata */ - name?: string; + requestBody?: Schema$SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Googleapisources$Testiampermissions extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - name?: string; + resource?: string; + /** - * The standard list page size. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Messagebuses { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + /** - * The standard list page token. + * 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. */ - pageToken?: string; + getIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Messagebuses$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Messagebuses$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Messagebuses$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Messagebuses$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Messagebuses$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Messagebuses$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Messagebuses$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Messagebuses$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Messagebuses$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.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$Messagebuses$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Messagebuses$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Messagebuses$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Messagebuses$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Messagebuses$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Messagebuses$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Messagebuses$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Messagebuses$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.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$Messagebuses$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$Messagebuses$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$Messagebuses$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://eventarc.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://eventarc.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://eventarc.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://eventarc.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$Pipelines { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Pipelines$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelines$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelines$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Pipelines$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Pipelines$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Pipelines$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelines$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelines$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Pipelines$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.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$Pipelines$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Pipelines$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Pipelines$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Pipelines$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Pipelines$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Pipelines$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Pipelines$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Pipelines$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://eventarc.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$Pipelines$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$Pipelines$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$Pipelines$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$Providers { diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index a83896bdbd..03889cea3c 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -269,6 +269,15 @@ export namespace file_v1 { */ sourceBackup?: string | null; } + /** + * Fixed IOPS (input/output operations per second) parameters. + */ + export interface Schema$FixedIOPS { + /** + * Required. Maximum raw read IOPS. + */ + maxReadIops?: string | null; + } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, \}, "labels": { "env": "prod", "foo": "bar" \}, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", \}, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", \} "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", \}, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", \} ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \}, "ncsa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \} \}, "consumer_defined_name": "my-sql-instance1", \} ``` LINT.IfChange */ @@ -478,6 +487,10 @@ export namespace file_v1 { * A Filestore instance. */ export interface Schema$Instance { + /** + * Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. + */ + configurablePerformanceEnabled?: boolean | null; /** * Output only. The time when the instance was created. */ @@ -518,6 +531,14 @@ export namespace file_v1 { * VPC networks to which the instance is connected. For this version, only a single network is supported. */ networks?: Schema$NetworkConfig[]; + /** + * Optional. Used to configure performance. + */ + performanceConfig?: Schema$PerformanceConfig; + /** + * Output only. Used for getting performance limits. + */ + performanceLimits?: Schema$PerformanceLimits; /** * Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. */ @@ -555,6 +576,15 @@ export namespace file_v1 { */ tier?: string | null; } + /** + * IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). + */ + export interface Schema$IOPSPerTB { + /** + * Required. Maximum read IOPS per TiB. + */ + maxReadIopsPerTb?: string | null; + } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -807,6 +837,40 @@ export namespace file_v1 { */ verb?: string | null; } + /** + * Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). + */ + export interface Schema$PerformanceConfig { + /** + * Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + */ + fixedIops?: Schema$FixedIOPS; + /** + * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + */ + iopsPerTb?: Schema$IOPSPerTB; + } + /** + * The enforced performance limits, calculated from the instance's performance configuration. + */ + export interface Schema$PerformanceLimits { + /** + * Output only. The max read IOPS. + */ + maxReadIops?: string | null; + /** + * Output only. The max read throughput in bytes per second. + */ + maxReadThroughputBps?: string | null; + /** + * Output only. The max write IOPS. + */ + maxWriteIops?: string | null; + /** + * Output only. The max write throughput in bytes per second. + */ + maxWriteThroughputBps?: string | null; + } /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 1f3df8f315..368ecc20d7 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -189,7 +189,7 @@ export namespace file_v1beta1 { */ storageBytes?: string | null; /** - * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + * Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */ tags?: {[key: string]: string} | null; } @@ -278,6 +278,15 @@ export namespace file_v1beta1 { */ sourceBackup?: string | null; } + /** + * Fixed IOPS (input/output operations per second) parameters. + */ + export interface Schema$FixedIOPS { + /** + * Required. Maximum raw read IOPS. + */ + maxReadIops?: string | null; + } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, \}, "labels": { "env": "prod", "foo": "bar" \}, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", \}, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", \} "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", \}, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", \} ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \}, "ncsa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \} \}, "consumer_defined_name": "my-sql-instance1", \} ``` LINT.IfChange */ @@ -495,10 +504,22 @@ export namespace file_v1beta1 { * Output only. The increase/decrease capacity step size. */ capacityStepSizeGb?: string | null; + /** + * Output only. Indicates whether this instance's performance is configurable. If enabled, adjust it using the 'performance_config' field. + */ + configurablePerformanceEnabled?: boolean | null; /** * Output only. The time when the instance was created. */ createTime?: string | null; + /** + * Optional. Indicates whether the instance is protected against deletion. + */ + deletionProtectionEnabled?: boolean | null; + /** + * Optional. The reason for enabling deletion protection. + */ + deletionProtectionReason?: string | null; /** * The description of the instance (2048 characters or less). */ @@ -543,12 +564,20 @@ export namespace file_v1beta1 { * VPC networks to which the instance is connected. For this version, only a single network is supported. */ networks?: Schema$NetworkConfig[]; + /** + * Optional. Used to configure performance. + */ + performanceConfig?: Schema$PerformanceConfig; + /** + * Output only. Used for getting performance limits. + */ + performanceLimits?: Schema$PerformanceLimits; /** * Immutable. The protocol indicates the access protocol for all shares in the instance. This field is immutable and it cannot be changed after the instance has been created. Default value: `NFS_V3`. */ protocol?: string | null; /** - * Optional. Replicaition configuration. + * Optional. Replication configuration. */ replication?: Schema$Replication; /** @@ -572,7 +601,7 @@ export namespace file_v1beta1 { */ suspensionReasons?: string[] | null; /** - * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + * Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */ tags?: {[key: string]: string} | null; /** @@ -580,6 +609,15 @@ export namespace file_v1beta1 { */ tier?: string | null; } + /** + * IOPS per TB. Filestore defines TB as 1024^4 bytes (TiB). + */ + export interface Schema$IOPSPerTB { + /** + * Required. Maximum read IOPS per TiB. + */ + maxReadIopsPerTb?: string | null; + } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -742,11 +780,11 @@ export namespace file_v1beta1 { weeklyCycle?: Schema$WeeklyCycle; } /** - * ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Active Directory. + * ManagedActiveDirectoryConfig contains all the parameters for connecting to Managed Service for Microsoft Active Directory (Managed Microsoft AD). */ export interface Schema$ManagedActiveDirectoryConfig { /** - * Required. The computer name is used as a prefix to the mount remote target. Example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. + * Required. The computer name is used as a prefix in the command to mount the remote target. For example: if the computer is `my-computer`, the mount command will look like: `$mount -o vers=4.1,sec=krb5 my-computer.filestore.: `. */ computer?: string | null; /** @@ -866,6 +904,40 @@ export namespace file_v1beta1 { */ verb?: string | null; } + /** + * Used for setting the performance configuration. If the user doesn't specify PerformanceConfig, automatically provision the default performance settings as described in https://cloud.google.com/filestore/docs/performance. Larger instances will be linearly set to more IOPS. If the instance's capacity is increased or decreased, its performance will be automatically adjusted upwards or downwards accordingly (respectively). + */ + export interface Schema$PerformanceConfig { + /** + * Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + */ + fixedIops?: Schema$FixedIOPS; + /** + * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by multiplying the capacity of the instance in TiB by the `iops_per_tb` value. For example, for a 2 TiB instance with an `iops_per_tb` value of 17000 the provisioned read IOPS will be 34000. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. + */ + iopsPerTb?: Schema$IOPSPerTB; + } + /** + * The enforced performance limits, calculated from the instance's performance configuration. + */ + export interface Schema$PerformanceLimits { + /** + * Output only. The max read IOPS. + */ + maxReadIops?: string | null; + /** + * Output only. The max read throughput in bytes per second. + */ + maxReadThroughputBps?: string | null; + /** + * Output only. The max write IOPS. + */ + maxWriteIops?: string | null; + /** + * Output only. The max write throughput in bytes per second. + */ + maxWriteThroughputBps?: string | null; + } /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ @@ -896,7 +968,7 @@ export namespace file_v1beta1 { */ export interface Schema$Replication { /** - * Replicas configuration on the instance. For now, only a single replica config is supported. + * Replication configuration for the replica instance associated with this instance. Only a single replica is supported. */ replicas?: Schema$ReplicaConfig[]; /** @@ -1017,7 +1089,7 @@ export namespace file_v1beta1 { */ state?: string | null; /** - * Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" + * Optional. Input only. Immutable. Tag key-value pairs are bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" */ tags?: {[key: string]: string} | null; } @@ -2281,7 +2353,7 @@ export namespace file_v1beta1 { } /** - * Promote an standby instance (replica). + * Promote the standby instance (replica). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2610,7 +2682,7 @@ export namespace file_v1beta1 { */ name?: string; /** - * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels" + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "directory_services" * "file_shares" * "labels" * "performance_config" * "deletion_protection_enabled" * "deletion_protection_reason" */ updateMask?: string; diff --git a/src/apis/firebase/v1beta1.ts b/src/apis/firebase/v1beta1.ts index 59c40b091c..efaf9c3a50 100644 --- a/src/apis/firebase/v1beta1.ts +++ b/src/apis/firebase/v1beta1.ts @@ -820,10 +820,22 @@ export namespace firebase_v1beta1 { * Immutable. A user-assigned unique identifier for the `FirebaseProject`. */ projectId?: string | null; + /** + * Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Google Cloud or third-party services. + */ + projectNumber?: string | null; + /** + * Optional. Duplicate field for the URL of the default RTDB instances (if there is one) that uses the same field name as the unified V2 config file format. We wanted to make a single config file format for all the app platforms (Android, iOS and web) and we had to pick consistent names for all the fields since there was some varience between the platforms. If the request asks for the V2 format we will populate this field instead of realtime_database_instance_uri. + */ + realtimeDatabaseUrl?: string | null; /** * **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name. */ storageBucket?: string | null; + /** + * Version of the config specification. + */ + version?: string | null; } export class Resource$Availableprojects { diff --git a/src/apis/firebaseappcheck/v1.ts b/src/apis/firebaseappcheck/v1.ts index 4f16954c3f..f49c070289 100644 --- a/src/apis/firebaseappcheck/v1.ts +++ b/src/apis/firebaseappcheck/v1.ts @@ -142,11 +142,11 @@ export namespace firebaseappcheck_v1 { tokenTtl?: string | null; } /** - * Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check. + * Encapsulates an *App Check token*, which are used to access backend services protected by App Check. */ export interface Schema$GoogleFirebaseAppcheckV1AppCheckToken { /** - * The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK. + * The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries. */ token?: string | null; /** @@ -603,7 +603,7 @@ export namespace firebaseappcheck_v1 { tokenTtl?: string | null; } /** - * App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration. + * App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. */ export interface Schema$GoogleFirebaseAppcheckV1ResourcePolicy { /** @@ -619,7 +619,7 @@ export namespace firebaseappcheck_v1 { */ name?: string | null; /** - * Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. + * Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. */ targetResource?: string | null; /** @@ -649,7 +649,7 @@ export namespace firebaseappcheck_v1 { */ enforcementMode?: string | null; /** - * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) + * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) */ name?: string | null; } @@ -671,7 +671,7 @@ export namespace firebaseappcheck_v1 { */ export interface Schema$GoogleFirebaseAppcheckV1UpdateServiceRequest { /** - * Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) + * Required. The Service to update. The Service's `name` field is used to identify the Service to be updated, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) */ service?: Schema$GoogleFirebaseAppcheckV1Service; /** @@ -5427,7 +5427,7 @@ export namespace firebaseappcheck_v1 { export interface Params$Resource$Projects$Services$Get extends StandardParameters { /** - * Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) + * Required. The relative resource name of the Service to retrieve, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) */ name?: string; } @@ -5449,7 +5449,7 @@ export namespace firebaseappcheck_v1 { export interface Params$Resource$Projects$Services$Patch extends StandardParameters { /** - * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) + * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `oauth2.googleapis.com` (Google Identity for iOS) */ name?: string; /** diff --git a/src/apis/firebaseappcheck/v1beta.ts b/src/apis/firebaseappcheck/v1beta.ts index eaf23874b7..d705adc096 100644 --- a/src/apis/firebaseappcheck/v1beta.ts +++ b/src/apis/firebaseappcheck/v1beta.ts @@ -142,15 +142,15 @@ export namespace firebaseappcheck_v1beta { tokenTtl?: string | null; } /** - * Encapsulates an *App Check token*, which are used to access Firebase services protected by App Check. + * Encapsulates an *App Check token*, which are used to access backend services protected by App Check. */ export interface Schema$GoogleFirebaseAppcheckV1betaAppCheckToken { /** - * An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. + * The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries. */ attestationToken?: string | null; /** - * An App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and Firebase project. This token is used to access Firebase services protected by App Check. + * The App Check token. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries. */ token?: string | null; /** @@ -663,7 +663,7 @@ export namespace firebaseappcheck_v1beta { tokenTtl?: string | null; } /** - * App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration. + * App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration. */ export interface Schema$GoogleFirebaseAppcheckV1betaResourcePolicy { /** @@ -679,7 +679,7 @@ export namespace firebaseappcheck_v1beta { */ name?: string | null; /** - * Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. + * Required. Service specific name of the resource object to which this policy applies, in the format: * **iOS OAuth clients** (Google Identity for iOS): `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. */ targetResource?: string | null; /** @@ -713,7 +713,7 @@ export namespace firebaseappcheck_v1beta { */ etag?: string | null; /** - * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) + * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) */ name?: string | null; /** @@ -6082,7 +6082,7 @@ export namespace firebaseappcheck_v1beta { export interface Params$Resource$Projects$Services$Patch extends StandardParameters { /** - * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) + * Required. The relative resource name of the service configuration object, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `firebasestorage.googleapis.com` (Cloud Storage for Firebase) * `firebasedatabase.googleapis.com` (Firebase Realtime Database) * `firestore.googleapis.com` (Cloud Firestore) * `identitytoolkit.googleapis.com` (Firebase Authentication with Identity Platform) * `oauth2.googleapis.com` (Google Identity for iOS) */ name?: string; /** diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index e593203bcc..fb0c304da1 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -257,6 +257,10 @@ export namespace firebaseappdistribution_v1alpha { */ screenshot?: Schema$GoogleFirebaseAppdistroV1alphaScreenshot; } + /** + * The (empty) response message for `CancelReleaseTest`. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaCancelReleaseTestResponse {} export interface Schema$GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest { /** * The actual release notes body from the user @@ -581,6 +585,10 @@ export namespace firebaseappdistribution_v1alpha { * The name of the release test resource. Format: `projects/{project_number\}/apps/{app_id\}/releases/{release_id\}/tests/{test_id\}` */ name?: string | null; + /** + * Output only. The state of the release test. + */ + testState?: string | null; } /** * Configuration for Robo crawler @@ -1941,6 +1949,104 @@ export namespace firebaseappdistribution_v1alpha { this.context = context; } + /** + * Abort automated test run on release. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Apps$Releases$Tests$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Apps$Releases$Tests$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Apps$Releases$Tests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Apps$Releases$Tests$Cancel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Apps$Releases$Tests$Cancel, + callback: BodyResponseCallback + ): void; + cancel( + callback: BodyResponseCallback + ): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Apps$Releases$Tests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Apps$Releases$Tests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Apps$Releases$Tests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappdistribution.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cancel').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 + ); + } + } + /** * Run automated test(s) on release. * @@ -2233,6 +2339,13 @@ export namespace firebaseappdistribution_v1alpha { } } + export interface Params$Resource$Projects$Apps$Releases$Tests$Cancel + extends StandardParameters { + /** + * Required. The name of the release test resource. Format: `projects/{project_number\}/apps/{app_id\}/releases/{release_id\}/tests/{test_id\}` + */ + name?: string; + } export interface Params$Resource$Projects$Apps$Releases$Tests$Create extends StandardParameters { /** @@ -2240,7 +2353,7 @@ export namespace firebaseappdistribution_v1alpha { */ parent?: string; /** - * Optional. The ID to use for the test, which will become the final component of the tests's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated. + * Optional. The ID to use for the test, which will become the final component of the test's resource name. This value should be 4-63 characters, and valid characters are /a-z-/. If it is not provided one will be automatically generated. */ releaseTestId?: string; diff --git a/src/apis/firebasedataconnect/README.md b/src/apis/firebasedataconnect/README.md new file mode 100644 index 0000000000..1c7bacdb4e --- /dev/null +++ b/src/apis/firebasedataconnect/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# firebasedataconnect + +> 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. + +## Installation + +```sh +$ npm install @googleapis/firebasedataconnect +``` + +## 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/firebasedataconnect/classes/Firebasedataconnect.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/firebasedataconnect/index.ts b/src/apis/firebasedataconnect/index.ts new file mode 100644 index 0000000000..7853e5dad0 --- /dev/null +++ b/src/apis/firebasedataconnect/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 {firebasedataconnect_v1beta} from './v1beta'; + +export const VERSIONS = { + v1beta: firebasedataconnect_v1beta.Firebasedataconnect, +}; + +export function firebasedataconnect( + version: 'v1beta' +): firebasedataconnect_v1beta.Firebasedataconnect; +export function firebasedataconnect( + options: firebasedataconnect_v1beta.Options +): firebasedataconnect_v1beta.Firebasedataconnect; +export function firebasedataconnect< + T = firebasedataconnect_v1beta.Firebasedataconnect, +>( + this: GoogleConfigurable, + versionOrOptions: 'v1beta' | firebasedataconnect_v1beta.Options +) { + return getAPI('firebasedataconnect', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {firebasedataconnect_v1beta}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/firebasedataconnect/package.json b/src/apis/firebasedataconnect/package.json new file mode 100644 index 0000000000..44b60a5a2a --- /dev/null +++ b/src/apis/firebasedataconnect/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/firebasedataconnect", + "version": "0.1.0", + "description": "firebasedataconnect", + "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/firebasedataconnect/tsconfig.json b/src/apis/firebasedataconnect/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/firebasedataconnect/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/firebasedataconnect/v1beta.ts b/src/apis/firebasedataconnect/v1beta.ts new file mode 100644 index 0000000000..a5c9fb3402 --- /dev/null +++ b/src/apis/firebasedataconnect/v1beta.ts @@ -0,0 +1,3410 @@ +// 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_v1beta { + export interface Options extends GlobalOptions { + version: 'v1beta'; + } + + 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 + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const firebasedataconnect = google.firebasedataconnect('v1beta'); + * ``` + */ + 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. + */ + 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. + */ + 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 much Postgresql schema validation to perform. Default to `STRICT` if not specified. + */ + 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 + '/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 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 + '/v1beta/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasedataconnect.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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 + '/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 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 + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$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 + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$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 + '/v1beta/{+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 + '/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); + } + } + + /** + * 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 + '/v1beta/{+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 + '/v1beta/{+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 + '/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 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 + '/v1beta/{+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 + '/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$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 + '/v1beta/{+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 + '/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); + } + } + + /** + * 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 + '/v1beta/{+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 + '/v1beta/{+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 + '/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 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 + '/v1beta/{+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 + '/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$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 + '/v1beta/{+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 + '/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 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 + '/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 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 + '/v1beta/{+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 + '/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$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/webpack.config.js b/src/apis/firebasedataconnect/webpack.config.js new file mode 100644 index 0000000000..ec3281abe6 --- /dev/null +++ b/src/apis/firebasedataconnect/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: 'Firebasedataconnect', + filename: 'firebasedataconnect.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/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index c8b09b1cc5..9db743e5d9 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -186,6 +186,10 @@ export namespace firebaseml_v2beta { * Output only. Index of the candidate. */ index?: number | null; + /** + * Output only. Log-likelihood scores for the response tokens and top tokens + */ + logprobsResult?: Schema$GoogleCloudAiplatformV1beta1LogprobsResult; /** * Output only. List of ratings for the safety of a response candidate. There is at most one rating per category. */ @@ -250,6 +254,10 @@ export namespace firebaseml_v2beta { * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Optional. Generation config that the model will use to generate the response. + */ + generationConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfig; /** * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ @@ -280,6 +288,19 @@ export namespace firebaseml_v2beta { */ totalTokens?: number | null; } + /** + * Describes the options to customize dynamic retrieval. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DynamicRetrievalConfig { + /** + * Optional. The threshold to be used in dynamic retrieval. If not set, a system default value is used. + */ + dynamicThreshold?: number | null; + /** + * The mode of the predictor to be used in dynamic retrieval. + */ + mode?: string | null; + } /** * URI based data. */ @@ -369,6 +390,10 @@ export namespace firebaseml_v2beta { * Optional. Generation config. */ generationConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfig; + /** + * Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter. + */ + labels?: {[key: string]: string} | null; /** * Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. */ @@ -394,6 +419,10 @@ export namespace firebaseml_v2beta { * Output only. Generated candidates. */ candidates?: Schema$GoogleCloudAiplatformV1beta1Candidate[]; + /** + * Output only. The model version used to generate the response. + */ + modelVersion?: string | null; /** * Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. */ @@ -445,6 +474,10 @@ export namespace firebaseml_v2beta { * Generation config. */ export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfig { + /** + * Optional. If enabled, audio timestamp will be included in the request to the model. + */ + audioTimestamp?: boolean | null; /** * Optional. Number of candidates to generate. */ @@ -453,6 +486,10 @@ export namespace firebaseml_v2beta { * Optional. Frequency penalties. */ frequencyPenalty?: number | null; + /** + * Optional. Logit probabilities. + */ + logprobs?: number | null; /** * Optional. The maximum number of output tokens to generate per message. */ @@ -461,6 +498,10 @@ export namespace firebaseml_v2beta { * Optional. Positive penalties. */ presencePenalty?: number | null; + /** + * Optional. If true, export the logprobs results in response. + */ + responseLogprobs?: boolean | null; /** * Optional. Output response mimetype of the generated candidate text. Supported mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON response in the candidates. The model needs to be prompted to output the appropriate response type, otherwise the behavior is undefined. This is a preview feature. */ @@ -528,7 +569,12 @@ export namespace firebaseml_v2beta { /** * Tool to retrieve public web data for grounding, powered by Google. */ - export interface Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {} + export interface Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval { + /** + * Specifies the dynamic retrieval configuration for the given source. + */ + dynamicRetrievalConfig?: Schema$GoogleCloudAiplatformV1beta1DynamicRetrievalConfig; + } /** * Grounding chunk. */ @@ -580,6 +626,10 @@ export namespace firebaseml_v2beta { * Optional. List of grounding support. */ groundingSupports?: Schema$GoogleCloudAiplatformV1beta1GroundingSupport[]; + /** + * Optional. Output only. Retrieval metadata. + */ + retrievalMetadata?: Schema$GoogleCloudAiplatformV1beta1RetrievalMetadata; /** * Optional. Queries executed by the retrieval tools. */ @@ -610,6 +660,45 @@ export namespace firebaseml_v2beta { */ segment?: Schema$GoogleCloudAiplatformV1beta1Segment; } + /** + * Logprobs Result + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResult { + /** + * Length = total number of decoding steps. The chosen candidates may or may not be in top_candidates. + */ + chosenCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; + /** + * Length = total number of decoding steps. + */ + topCandidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates[]; + } + /** + * Candidate for the logprobs token and score. + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate { + /** + * The candidate's log probability. + */ + logProbability?: number | null; + /** + * The candidate's token string value. + */ + token?: string | null; + /** + * The candidate's token id value. + */ + tokenId?: number | null; + } + /** + * Candidates with top log probabilities at each decoding step. + */ + export interface Schema$GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates { + /** + * Sorted by log probability in descending order. + */ + candidates?: Schema$GoogleCloudAiplatformV1beta1LogprobsResultCandidate[]; + } /** * A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. */ @@ -656,6 +745,15 @@ export namespace firebaseml_v2beta { */ vertexRagStore?: Schema$GoogleCloudAiplatformV1beta1VertexRagStore; } + /** + * Metadata related to retrieval in the grounding flow. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrievalMetadata { + /** + * Optional. Score indicating how likely information from Google Search could help answer the prompt. The score is in the range `[0, 1]`, where 0 is the least likely and 1 is the most likely. This score is only populated when Google Search grounding and dynamic retrieval is enabled. It will be compared to the threshold to determine whether to trigger Google Search. + */ + googleSearchDynamicRetrievalScore?: number | null; + } /** * Safety rating corresponding to the generated content. */ @@ -706,6 +804,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. The value should be validated against any (one or more) of the subschemas in the list. + */ + anyOf?: Schema$GoogleCloudAiplatformV1beta1Schema[]; /** * Optional. Default value of the data. */ @@ -715,7 +817,7 @@ export namespace firebaseml_v2beta { */ description?: string | null; /** - * Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]\} + * Optional. Possible values of the element of primitive type with enum format. Examples: 1. We can define direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]\} 2. We can define apartment number as : {type:INTEGER, format:enum, enum:["101", "201", "301"]\} */ enum?: string[] | null; /** @@ -776,6 +878,10 @@ export namespace firebaseml_v2beta { properties?: { [key: string]: Schema$GoogleCloudAiplatformV1beta1Schema; } | null; + /** + * 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. Required properties of Type.OBJECT. */ @@ -828,7 +934,7 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1Tool { /** - * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + * Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided. */ functionDeclarations?: Schema$GoogleCloudAiplatformV1beta1FunctionDeclaration[]; /** diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 579d5c6a8b..bfe93f0900 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -696,6 +696,15 @@ export namespace firestore_v1 { */ weeklyRecurrence?: Schema$GoogleFirestoreAdminV1WeeklyRecurrence; } + /** + * Information about a backup that was used to restore a database. + */ + export interface Schema$GoogleFirestoreAdminV1BackupSource { + /** + * The resource name of the backup that was used to restore this database. Format: `projects/{project\}/locations/{location\}/backups/{backup\}`. + */ + backup?: string | null; + } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments. */ @@ -832,6 +841,10 @@ export namespace firestore_v1 { * Output only. The database resource's prior database ID. This field is only populated for deleted databases. */ previousId?: string | null; + /** + * Output only. Information about the provenance of this database. + */ + sourceInfo?: Schema$GoogleFirestoreAdminV1SourceInfo; /** * The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose. */ @@ -1294,6 +1307,19 @@ export namespace firestore_v1 { * The configuration options for using the same encryption method as the source. */ export interface Schema$GoogleFirestoreAdminV1SourceEncryptionOptions {} + /** + * Information about the provenance of this database. + */ + export interface Schema$GoogleFirestoreAdminV1SourceInfo { + /** + * If set, this database was restored from the specified backup (or a snapshot thereof). + */ + backup?: Schema$GoogleFirestoreAdminV1BackupSource; + /** + * The associated long-running operation. This field may not be set after the operation has completed. Format: `projects/{project\}/databases/{database\}/operations/{operation\}`. + */ + operation?: string | null; + } /** * Backup specific statistics. */ @@ -7126,6 +7152,10 @@ export namespace firestore_v1 { } export interface Params$Resource$Projects$Locations$Backups$List extends StandardParameters { + /** + * An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: * `database_uid` (supports `=` only) + */ + filter?: string; /** * Required. The location to list backups from. Format is `projects/{project\}/locations/{location\}`. Use `{location\} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. */ diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 62e6953389..18827b68c1 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -1468,6 +1468,19 @@ export namespace gkehub_v1 { */ userClaim?: string | null; } + /** + * Configuration options for the AIS diagnostic interface. + */ + export interface Schema$IdentityServiceDiagnosticInterface { + /** + * Determines whether to enable the diagnostic interface. + */ + enabled?: boolean | null; + /** + * Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + */ + expirationTime?: string | null; + } /** * Configuration for the Google Plugin Auth flow. */ @@ -1499,7 +1512,11 @@ export namespace gkehub_v1 { */ export interface Schema$IdentityServiceIdentityServiceOptions { /** - * Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + * Configuration options for the AIS diagnostic interface. + */ + diagnosticInterface?: Schema$IdentityServiceDiagnosticInterface; + /** + * Determines the lifespan of STS tokens issued by Anthos Identity Service. */ sessionDuration?: string | null; } diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index df9e117acf..fb1925e390 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -1525,6 +1525,19 @@ export namespace gkehub_v1alpha { */ manifest?: Schema$ConnectAgentResource[]; } + /** + * The response of the exclusivity artifacts manifests for the client to apply. + */ + export interface Schema$GenerateExclusivityManifestResponse { + /** + * The YAML manifest of the membership CRD to apply if a newer version of the CRD is available. Empty if no update needs to be applied. + */ + crdManifest?: string | null; + /** + * The YAML manifest of the membership CR to apply if a new version of the CR is available. Empty if no update needs to be applied. + */ + crManifest?: string | null; + } /** * Response for GenerateRBACRoleBindingYAML. */ @@ -1630,6 +1643,19 @@ export namespace gkehub_v1alpha { */ userClaim?: string | null; } + /** + * Configuration options for the AIS diagnostic interface. + */ + export interface Schema$IdentityServiceDiagnosticInterface { + /** + * Determines whether to enable the diagnostic interface. + */ + enabled?: boolean | null; + /** + * Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + */ + expirationTime?: string | null; + } /** * Configuration for the Google Plugin Auth flow. */ @@ -1661,7 +1687,11 @@ export namespace gkehub_v1alpha { */ export interface Schema$IdentityServiceIdentityServiceOptions { /** - * Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + * Configuration options for the AIS diagnostic interface. + */ + diagnosticInterface?: Schema$IdentityServiceDiagnosticInterface; + /** + * Determines the lifespan of STS tokens issued by Anthos Identity Service. */ sessionDuration?: string | null; } @@ -3293,6 +3323,15 @@ export namespace gkehub_v1alpha { */ validationResults?: Schema$ValidationResult[]; } + /** + * The response of exclusivity artifacts validation result status. + */ + export interface Schema$ValidateExclusivityResponse { + /** + * The validation result. * `OK` means that exclusivity is validated, assuming the manifest produced by GenerateExclusivityManifest is successfully applied. * `ALREADY_EXISTS` means that the Membership CRD is already owned by another Hub. See `status.message` for more information. + */ + status?: Schema$GoogleRpcStatus; + } /** * ValidationResults are results set by each validator running during ValidateCreateMembership. */ @@ -5307,6 +5346,103 @@ export namespace gkehub_v1alpha { } } + /** + * GenerateExclusivityManifest generates the manifests to update the exclusivity artifacts in the cluster if needed. Exclusivity artifacts include the Membership custom resource definition (CRD) and the singleton Membership custom resource (CR). Combined with ValidateExclusivity, exclusivity artifacts guarantee that a Kubernetes cluster is only registered to a single GKE Hub. The Membership CRD is versioned, and may require conversion when the GKE Hub API server begins serving a newer version of the CRD and corresponding CR. The response will be the converted CRD and CR if there are any differences between the versions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateExclusivityManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest, + options: StreamMethodOptions + ): GaxiosPromise; + generateExclusivityManifest( + params?: Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest, + options?: MethodOptions + ): GaxiosPromise; + generateExclusivityManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateExclusivityManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateExclusivityManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest, + callback: BodyResponseCallback + ): void; + generateExclusivityManifest( + callback: BodyResponseCallback + ): void; + generateExclusivityManifest( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+name}:generateExclusivityManifest' + ).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 Membership. * @@ -6037,6 +6173,101 @@ export namespace gkehub_v1alpha { ); } } + + /** + * ValidateExclusivity validates the state of exclusivity in the cluster. The validation does not depend on an existing Hub membership 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. + */ + validateExclusivity( + params: Params$Resource$Projects$Locations$Memberships$Validateexclusivity, + options: StreamMethodOptions + ): GaxiosPromise; + validateExclusivity( + params?: Params$Resource$Projects$Locations$Memberships$Validateexclusivity, + options?: MethodOptions + ): GaxiosPromise; + validateExclusivity( + params: Params$Resource$Projects$Locations$Memberships$Validateexclusivity, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validateExclusivity( + params: Params$Resource$Projects$Locations$Memberships$Validateexclusivity, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + validateExclusivity( + params: Params$Resource$Projects$Locations$Memberships$Validateexclusivity, + callback: BodyResponseCallback + ): void; + validateExclusivity( + callback: BodyResponseCallback + ): void; + validateExclusivity( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Validateexclusivity + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Validateexclusivity; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Validateexclusivity; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/memberships:validateExclusivity' + ).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$Memberships$Create @@ -6105,6 +6336,21 @@ export namespace gkehub_v1alpha { */ version?: string; } + export interface Params$Resource$Projects$Locations$Memberships$Generateexclusivitymanifest + extends StandardParameters { + /** + * Optional. The YAML manifest of the membership CRD retrieved by `kubectl get customresourcedefinitions membership`. Leave empty if the resource does not exist. + */ + crdManifest?: string; + /** + * Optional. The YAML manifest of the membership CR retrieved by `kubectl get memberships membership`. Leave empty if the resource does not exist. + */ + crManifest?: string; + /** + * Required. The Membership resource name in the format `projects/x/locations/x/memberships/x`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Memberships$Get extends StandardParameters { /** @@ -6225,6 +6471,21 @@ export namespace gkehub_v1alpha { */ requestBody?: Schema$ValidateCreateMembershipRequest; } + export interface Params$Resource$Projects$Locations$Memberships$Validateexclusivity + extends StandardParameters { + /** + * Optional. The YAML of the membership CR in the cluster. Empty if the membership CR does not exist. + */ + crManifest?: string; + /** + * Required. The intended membership name under the `parent`. This method only does validation in anticipation of a CreateMembership call with the same name. + */ + intendedMembership?: string; + /** + * Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/x/locations/x`. + */ + parent?: string; + } export class Resource$Projects$Locations$Memberships$Bindings { context: APIRequestContext; diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index b8557d49bc..022bd4a059 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -1537,6 +1537,19 @@ export namespace gkehub_v1beta { */ userClaim?: string | null; } + /** + * Configuration options for the AIS diagnostic interface. + */ + export interface Schema$IdentityServiceDiagnosticInterface { + /** + * Determines whether to enable the diagnostic interface. + */ + enabled?: boolean | null; + /** + * Determines the expiration time of the diagnostic interface enablement. When reached, requests to the interface would be automatically rejected. + */ + expirationTime?: string | null; + } /** * Configuration for the Google Plugin Auth flow. */ @@ -1568,7 +1581,11 @@ export namespace gkehub_v1beta { */ export interface Schema$IdentityServiceIdentityServiceOptions { /** - * Optional. Determines the lifespan of STS tokens issued by Anthos Identity Service. + * Configuration options for the AIS diagnostic interface. + */ + diagnosticInterface?: Schema$IdentityServiceDiagnosticInterface; + /** + * Determines the lifespan of STS tokens issued by Anthos Identity Service. */ sessionDuration?: string | null; } diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index b7acf2e7a9..f5aec45653 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -666,7 +666,7 @@ export namespace healthcare_v1 { */ name?: string | null; /** - * Notification destination for new DICOM instances. Supplied by the client. + * Optional. Notification destination for new DICOM instances. Supplied by the client. */ notificationConfig?: Schema$NotificationConfig; /** @@ -962,15 +962,15 @@ export namespace healthcare_v1 { */ export interface Schema$FhirNotificationConfig { /** - * The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). + * Optional. The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). */ pubsubTopic?: string | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + * Optional. Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. */ sendFullResource?: boolean | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + * Optional. Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. */ sendPreviousResourceOnDelete?: boolean | null; } @@ -983,7 +983,7 @@ export namespace healthcare_v1 { */ complexDataTypeReferenceParsing?: string | null; /** - * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. + * Optional. If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. */ defaultSearchHandlingStrict?: boolean | null; /** @@ -995,7 +995,7 @@ export namespace healthcare_v1 { */ disableResourceVersioning?: boolean | null; /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. + * Optional. Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. */ enableUpdateCreate?: boolean | null; /** @@ -1011,11 +1011,11 @@ export namespace healthcare_v1 { */ notificationConfig?: Schema$NotificationConfig; /** - * Specifies where and whether to send notifications upon changes to a FHIR store. + * Optional. Specifies where and whether to send notifications upon changes to a FHIR store. */ notificationConfigs?: Schema$FhirNotificationConfig[]; /** - * A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. + * Optional. A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. */ streamConfigs?: Schema$StreamConfig[]; /** @@ -1204,19 +1204,19 @@ export namespace healthcare_v1 { */ export interface Schema$GoogleCloudHealthcareV1FhirBigQueryDestination { /** - * BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. + * Optional. BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. */ datasetUri?: string | null; /** - * The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + * Optional. The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. */ force?: boolean | null; /** - * The configuration for the exported BigQuery schema. + * Optional. The configuration for the exported BigQuery schema. */ schemaConfig?: Schema$SchemaConfig; /** - * Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. + * Optional. Determines if existing data in the destination dataset is overwritten, appended to, or not written if the tables contain data. If a write_disposition is specified, the `force` parameter is ignored. */ writeDisposition?: string | null; } @@ -1276,7 +1276,7 @@ export namespace healthcare_v1 { */ export interface Schema$Hl7V2NotificationConfig { /** - * Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `\>`, `\>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `\>`, `\>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`. + * Optional. Restricts notifications sent for messages matching a filter. If this is empty, all messages are matched. The following syntax is available: * A string field value can be written as text inside quotation marks, for example `"query text"`. The only valid relational operation for text fields is equality (`=`), where text is searched within the field, rather than having the field be equal to the text. For example, `"Comment = great"` returns messages with `great` in the comment field. * A number field value can be written as an integer, a decimal, or an exponential. The valid relational operators for number fields are the equality operator (`=`), along with the less than/greater than operators (`<`, `<=`, `\>`, `\>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * A date field value must be written in `yyyy-mm-dd` form. Fields with date and time use the RFC3339 time format. Leading zeros are required for one-digit months and days. The valid relational operators for date fields are the equality operator (`=`) , along with the less than/greater than operators (`<`, `<=`, `\>`, `\>=`). Note that there is no inequality (`!=`) operator. You can prepend the `NOT` operator to an expression to negate it. * Multiple field query expressions can be combined in one query by adding `AND` or `OR` operators between the expressions. If a boolean operator appears within a quoted string, it is not treated as special, it's just another part of the character string to be matched. You can prepend the `NOT` operator to an expression to negate it. The following fields and functions are available for filtering: * `message_type`, from the MSH-9.1 field. For example, `NOT message_type = "ADT"`. * `send_date` or `sendDate`, the YYYY-MM-DD date the message was sent in the dataset's time_zone, from the MSH-7 segment. For example, `send_date < "2017-01-02"`. * `send_time`, the timestamp when the message was sent, using the RFC3339 time format for comparisons, from the MSH-7 segment. For example, `send_time < "2017-01-02T00:00:00-05:00"`. * `create_time`, the timestamp when the message was created in the HL7v2 store. Use the RFC3339 time format for comparisons. For example, `create_time < "2017-01-02T00:00:00-05:00"`. * `send_facility`, the care center that the message came from, from the MSH-4 segment. For example, `send_facility = "ABC"`. * `PatientId(value, type)`, which matches if the message lists a patient having an ID of the given value and type in the PID-2, PID-3, or PID-4 segments. For example, `PatientId("123456", "MRN")`. * `labels.x`, a string value of the label with key `x` as set using the Message.labels map. For example, `labels."priority"="high"`. The operator `:*` can be used to assert the existence of a label. For example, `labels."priority":*`. */ filter?: string | null; /** @@ -1297,15 +1297,15 @@ export namespace healthcare_v1 { */ name?: string | null; /** - * A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. + * Optional. A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. */ notificationConfigs?: Schema$Hl7V2NotificationConfig[]; /** - * The configuration for the parser. It determines how the server parses the messages. + * Optional. The configuration for the parser. It determines how the server parses the messages. */ parserConfig?: Schema$ParserConfig; /** - * Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. + * Optional. Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. */ rejectDuplicateMessage?: boolean | null; } @@ -1794,11 +1794,11 @@ export namespace healthcare_v1 { */ export interface Schema$ParserConfig { /** - * Determines whether messages with no header are allowed. + * Optional. Determines whether messages with no header are allowed. */ allowNullHeader?: boolean | null; /** - * Schemas used to parse messages in this store, if schematized parsing is desired. + * Optional. Schemas used to parse messages in this store, if schematized parsing is desired. */ schema?: Schema$SchemaPackage; /** @@ -2099,23 +2099,23 @@ export namespace healthcare_v1 { */ export interface Schema$SchemaPackage { /** - * Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent. + * Optional. Flag to ignore all min_occurs restrictions in the schema. This means that incoming messages can omit any group, segment, field, component, or subcomponent. */ ignoreMinOccurs?: boolean | null; /** - * Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message. + * Optional. Schema configs that are layered based on their VersionSources that match the incoming message. Schema configs present in higher indices override those in lower indices with the same message type and trigger event if their VersionSources all match an incoming message. */ schemas?: Schema$Hl7SchemaConfig[]; /** - * Determines how messages that fail to parse are handled. + * Optional. Determines how messages that fail to parse are handled. */ schematizedParsingType?: string | null; /** - * Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message. + * Optional. Schema type definitions that are layered based on their VersionSources that match the incoming message. Type definitions present in higher indices override those in lower indices with the same type name if their VersionSources all match an incoming message. */ types?: Schema$Hl7TypesConfig[]; /** - * Determines how unexpected segments (segments not matched to the schema) are handled. + * Optional. Determines how unexpected segments (segments not matched to the schema) are handled. */ unexpectedSegmentHandling?: string | null; } @@ -2286,7 +2286,7 @@ export namespace healthcare_v1 { */ export interface Schema$StreamConfig { /** - * The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). + * Optional. The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). */ bigqueryDestination?: Schema$GoogleCloudHealthcareV1FhirBigQueryDestination; /** @@ -2294,7 +2294,7 @@ export namespace healthcare_v1 { */ deidentifiedStoreDestination?: Schema$DeidentifiedStoreDestination; /** - * Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. + * Optional. Supply a FHIR resource type (such as "Patient" or "Observation"). See https://www.hl7.org/fhir/valueset-resource-types.html for a list of all FHIR resource types. The server treats an empty list as an intent to stream all the supported resource types in this FHIR store. */ resourceTypes?: string[] | null; } @@ -12868,6 +12868,353 @@ export namespace healthcare_v1 { this.context = context; } + /** + * Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryCreate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options?: MethodOptions + ): GaxiosPromise; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + callback: BodyResponseCallback + ): void; + BinaryCreate(callback: BodyResponseCallback): void; + BinaryCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/fhir/Binary').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 the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryRead( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options?: MethodOptions + ): GaxiosPromise; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + callback: BodyResponseCallback + ): void; + BinaryRead(callback: BodyResponseCallback): void; + BinaryRead( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryUpdate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options?: MethodOptions + ): GaxiosPromise; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + callback: BodyResponseCallback + ): void; + BinaryUpdate(callback: BodyResponseCallback): void; + BinaryUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryVread( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options?: MethodOptions + ): GaxiosPromise; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + callback: BodyResponseCallback + ): void; + BinaryVread(callback: BodyResponseCallback): void; + BinaryVread( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * @@ -14360,6 +14707,44 @@ export namespace healthcare_v1 { } } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate + extends StandardParameters { + /** + * Required. The name of the FHIR store this resource belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread + extends StandardParameters { + /** + * Required. The name of the Binary resource to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate + extends StandardParameters { + /** + * Required. The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread + extends StandardParameters { + /** + * Required. The name of the Binary resource version to retrieve. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 37bddd24a6..5a98e0ccb1 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -16165,6 +16165,353 @@ export namespace healthcare_v1beta1 { this.context = context; } + /** + * Creates a FHIR Binary resource. This method can be used to create a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is created with this method using the FHIR content type this method's behavior is the same as [`fhir.create`](https://cloud.google.com/healthcare-api/docs/reference/rest/v1/projects.locations.datasets.fhirStores.fhir/create). If a resource type other than Binary is used in the request it's treated in the same way as non-FHIR data (e.g., images, zip archives, pdf files, documents). When a non-FHIR content type is used in the request, a Binary resource will be generated, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty `201 Created` response is returned. The newly created resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryCreate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options?: MethodOptions + ): GaxiosPromise; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryCreate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate, + callback: BodyResponseCallback + ): void; + BinaryCreate(callback: BodyResponseCallback): void; + BinaryCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/fhir/Binary').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 the contents of a FHIR Binary resource. This method can be used to retrieve a Binary resource either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryRead( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options?: MethodOptions + ): GaxiosPromise; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryRead( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread, + callback: BodyResponseCallback + ): void; + BinaryRead(callback: BodyResponseCallback): void; + BinaryRead( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the entire contents of a Binary resource. If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud Audit Logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. This method can be used to update a Binary resource either by using one of the accepted FHIR JSON content types, or as a raw data stream. If a resource is updated with this method using the FHIR content type this method's behavior is the same as `update`. If a resource type other than Binary is used in the request it will be treated in the same way as non-FHIR data. When a non-FHIR content type is used in the request, a Binary resource will be generated using the ID from the resource path, and the uploaded data will be stored in the `content` field (`DSTU2` and `STU3`), or the `data` field (`R4`). The Binary resource's `contentType` will be filled in using the value of the `Content-Type` header, and the `securityContext` field (not present in `DSTU2`) will be populated from the `X-Security-Context` header if it exists. At this time `securityContext` has no special behavior in the Cloud Healthcare API. Note: the limit on data ingested through this method is 2 GB. For best performance, use a non-FHIR data type instead of wrapping the data in a Binary resource. Some of the Healthcare API features, such as [exporting to BigQuery](https://cloud.google.com/healthcare-api/docs/how-tos/fhir-export-bigquery) or [Pub/Sub notifications](https://cloud.google.com/healthcare-api/docs/fhir-pubsub#behavior_when_a_fhir_resource_is_too_large_or_traffic_is_high) with full resource content, do not support Binary resources that are larger than 10 MB. In these cases the resource's `data` field will be omitted. Instead, the "http://hl7.org/fhir/StructureDefinition/data-absent-reason" extension will be present to indicate that including the data is `unsupported`. On success, an empty 200 OK response will be returned, or a 201 Created if the resource did not exit. The resource's ID and version are returned in the Location header. Using `Prefer: representation=resource` is not allowed for this method. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryUpdate( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options?: MethodOptions + ): GaxiosPromise; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryUpdate( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate, + callback: BodyResponseCallback + ): void; + BinaryUpdate(callback: BodyResponseCallback): void; + BinaryUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the contents of a version (current or historical) of a FHIR Binary resource by version ID. This method can be used to retrieve a Binary resource version either by using the FHIR JSON mimetype as the value for the Accept header, or as a raw data stream. If the FHIR Accept type is used this method will return a Binary resource with the data base64-encoded, regardless of how the resource version was created. The resource data can be retrieved in base64-decoded form if the Accept type of the request matches the value of the resource version's `contentType` field. The definition of the Binary REST API can be found at https://hl7.org/fhir/binary.html#rest. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: StreamMethodOptions + ): GaxiosPromise; + BinaryVread( + params?: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options?: MethodOptions + ): GaxiosPromise; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + BinaryVread( + params: Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread, + callback: BodyResponseCallback + ): void; + BinaryVread(callback: BodyResponseCallback): void; + BinaryVread( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the FHIR capability statement ([STU3](https://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](https://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](https://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](https://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](https://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](https://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body contains a JSON-encoded representation of a `CapabilityStatement` resource. * @@ -18289,6 +18636,44 @@ export namespace healthcare_v1beta1 { } } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binarycreate + extends StandardParameters { + /** + * Required. The name of the FHIR store this resource belongs to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryread + extends StandardParameters { + /** + * Required. The name of the Binary resource to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryupdate + extends StandardParameters { + /** + * Required. The name of the resource to update. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpBody; + } + export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Binaryvread + extends StandardParameters { + /** + * Required. The name of the Binary resource version to retrieve. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Fhirstores$Fhir$Capabilities extends StandardParameters { /** diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 93d3ace65c..a8bad88b36 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -168,7 +168,7 @@ export namespace iap_v1 { */ oauthSettings?: Schema$OAuthSettings; /** - * Optional. Settings to configure Policy delegation for apps hosted in tenant projects. INTERNAL_ONLY. + * Optional. Settings to allow google-internal teams to use IAP for apps hosted in a tenant project. */ policyDelegationSettings?: Schema$PolicyDelegationSettings; /** @@ -514,7 +514,7 @@ export namespace iap_v1 { */ maxAge?: string | null; /** - * Reauth method requested. + * Optional. Reauth method requested. */ method?: string | null; /** diff --git a/src/apis/index.ts b/src/apis/index.ts index 45cb3d93c4..51f79af652 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -337,6 +337,10 @@ import { VERSIONS as firebasedatabaseVersions, firebasedatabase, } from './firebasedatabase'; +import { + VERSIONS as firebasedataconnectVersions, + firebasedataconnect, +} from './firebasedataconnect'; import { VERSIONS as firebasedynamiclinksVersions, firebasedynamiclinks, @@ -490,6 +494,10 @@ import { VERSIONS as ondemandscanningVersions, ondemandscanning, } from './ondemandscanning'; +import { + VERSIONS as oracledatabaseVersions, + oracledatabase, +} from './oracledatabase'; import {VERSIONS as orgpolicyVersions, orgpolicy} from './orgpolicy'; import {VERSIONS as osconfigVersions, osconfig} from './osconfig'; import {VERSIONS as osloginVersions, oslogin} from './oslogin'; @@ -857,6 +865,7 @@ export const APIS: APIList = { firebaseappcheck: firebaseappcheckVersions, firebaseappdistribution: firebaseappdistributionVersions, firebasedatabase: firebasedatabaseVersions, + firebasedataconnect: firebasedataconnectVersions, firebasedynamiclinks: firebasedynamiclinksVersions, firebasehosting: firebasehostingVersions, firebaseml: firebasemlVersions, @@ -923,6 +932,7 @@ export const APIS: APIList = { notebooks: notebooksVersions, oauth2: oauth2Versions, ondemandscanning: ondemandscanningVersions, + oracledatabase: oracledatabaseVersions, orgpolicy: orgpolicyVersions, osconfig: osconfigVersions, oslogin: osloginVersions, @@ -1160,6 +1170,7 @@ export class GeneratedAPIs { firebaseappcheck = firebaseappcheck; firebaseappdistribution = firebaseappdistribution; firebasedatabase = firebasedatabase; + firebasedataconnect = firebasedataconnect; firebasedynamiclinks = firebasedynamiclinks; firebasehosting = firebasehosting; firebaseml = firebaseml; @@ -1226,6 +1237,7 @@ export class GeneratedAPIs { notebooks = notebooks; oauth2 = oauth2; ondemandscanning = ondemandscanning; + oracledatabase = oracledatabase; orgpolicy = orgpolicy; osconfig = osconfig; oslogin = oslogin; diff --git a/src/apis/language/v2.ts b/src/apis/language/v2.ts index 2e802cce8c..1f198d75c9 100644 --- a/src/apis/language/v2.ts +++ b/src/apis/language/v2.ts @@ -271,6 +271,10 @@ export namespace language_v2 { * The name of the category representing the document. */ name?: string | null; + /** + * Optional. The classifier's severity of the category. This is only present when the ModerateTextRequest.ModelVersion is set to MODEL_VERSION_2, and the corresponding category has a severity score. + */ + severity?: number | null; } /** * The document classification request message. @@ -472,6 +476,10 @@ export namespace language_v2 { * Required. Input document. */ document?: Schema$Document; + /** + * Optional. The model version to use for ModerateText. + */ + modelVersion?: string | null; } /** * The document moderation response message. diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 79c9da0cad..6b197fac0e 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -750,6 +750,19 @@ export namespace logging_v2 { */ nextPageToken?: string | null; } + /** + * The response from ListLogScopes. Every project has a _Default log scope that cannot be modified or deleted. + */ + export interface Schema$ListLogScopesResponse { + /** + * A list of log scopes. + */ + logScopes?: Schema$LogScope[]; + /** + * If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken. + */ + nextPageToken?: string | null; + } /** * Result returned from ListLogs. */ @@ -888,7 +901,7 @@ export namespace logging_v2 { */ export interface Schema$LogBucket { /** - * Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. + * Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. */ analyticsEnabled?: boolean | null; /** @@ -1188,6 +1201,31 @@ export namespace logging_v2 { */ version?: string | null; } + /** + * Describes a group of resources to read log entries from. + */ + export interface Schema$LogScope { + /** + * Output only. The creation timestamp of the log scope. + */ + createTime?: string | null; + /** + * Optional. Describes this log scope.The maximum length of the description is 8000 characters. + */ + description?: string | null; + /** + * Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope + */ + name?: string | null; + /** + * Required. Names of one or more parent resources: projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 50 projects and a maximum of 100 resources in total. + */ + resourceNames?: string[] | null; + /** + * Output only. The last update timestamp of the log scope. + */ + updateTime?: string | null; + } /** * Describes a sink used to export log entries to one of the following destinations: a Cloud Logging log bucket, a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic, a Cloud project.A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder. */ @@ -1356,6 +1394,10 @@ export namespace logging_v2 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" \}\} @@ -8144,12 +8186,14 @@ export namespace logging_v2 { export class Resource$Folders$Locations { context: APIRequestContext; buckets: Resource$Folders$Locations$Buckets; + logScopes: Resource$Folders$Locations$Logscopes; operations: Resource$Folders$Locations$Operations; recentQueries: Resource$Folders$Locations$Recentqueries; savedQueries: Resource$Folders$Locations$Savedqueries; constructor(context: APIRequestContext) { this.context = context; this.buckets = new Resource$Folders$Locations$Buckets(this.context); + this.logScopes = new Resource$Folders$Locations$Logscopes(this.context); this.operations = new Resource$Folders$Locations$Operations(this.context); this.recentQueries = new Resource$Folders$Locations$Recentqueries( this.context @@ -10512,64 +10556,64 @@ export namespace logging_v2 { resourceNames?: string[]; } - export class Resource$Folders$Locations$Operations { + export class Resource$Folders$Locations$Logscopes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. + * Creates a log 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. */ - cancel( - params: Params$Resource$Folders$Locations$Operations$Cancel, + create( + params: Params$Resource$Folders$Locations$Logscopes$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Folders$Locations$Operations$Cancel, + create( + params?: Params$Resource$Folders$Locations$Logscopes$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Folders$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Folders$Locations$Logscopes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Folders$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Folders$Locations$Logscopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Folders$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Folders$Locations$Logscopes$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Folders$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Folders$Locations$Logscopes$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$Folders$Locations$Operations$Cancel; + {}) as Params$Resource$Folders$Locations$Logscopes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Operations$Cancel; + params = {} as Params$Resource$Folders$Locations$Logscopes$Create; options = {}; } @@ -10582,79 +10626,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/logScopes').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 log 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$Folders$Locations$Operations$Get, + delete( + params: Params$Resource$Folders$Locations$Logscopes$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Folders$Locations$Operations$Get, + delete( + params?: Params$Resource$Folders$Locations$Logscopes$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Folders$Locations$Operations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Locations$Logscopes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Folders$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Locations$Logscopes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Folders$Locations$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Locations$Logscopes$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Folders$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Folders$Locations$Logscopes$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$Folders$Locations$Operations$Get; + {}) as Params$Resource$Folders$Locations$Logscopes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Operations$Get; + params = {} as Params$Resource$Folders$Locations$Logscopes$Delete; options = {}; } @@ -10668,7 +10715,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -10679,72 +10726,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. + * Gets a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Folders$Locations$Operations$List, + get( + params: Params$Resource$Folders$Locations$Logscopes$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Folders$Locations$Operations$List, + get( + params?: Params$Resource$Folders$Locations$Logscopes$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Folders$Locations$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Locations$Logscopes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Folders$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Folders$Locations$Logscopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Folders$Locations$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Folders$Locations$Logscopes$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Folders$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Folders$Locations$Logscopes$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$Folders$Locations$Operations$List; + {}) as Params$Resource$Folders$Locations$Logscopes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Operations$List; + params = {} as Params$Resource$Folders$Locations$Logscopes$Get; options = {}; } @@ -10757,10 +10799,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -10772,63 +10811,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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$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$Folders$Locations$Recentqueries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the RecentQueries that were created by the user making the request. + * Lists log scopes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10836,56 +10829,54 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Folders$Locations$Recentqueries$List, + params: Params$Resource$Folders$Locations$Logscopes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Folders$Locations$Recentqueries$List, + params?: Params$Resource$Folders$Locations$Logscopes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Folders$Locations$Recentqueries$List, + params: Params$Resource$Folders$Locations$Logscopes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Locations$Recentqueries$List, + params: Params$Resource$Folders$Locations$Logscopes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Folders$Locations$Recentqueries$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Logscopes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Folders$Locations$Recentqueries$List - | BodyResponseCallback + | Params$Resource$Folders$Locations$Logscopes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Locations$Recentqueries$List; + {}) as Params$Resource$Folders$Locations$Logscopes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Recentqueries$List; + params = {} as Params$Resource$Folders$Locations$Logscopes$List; options = {}; } @@ -10898,7 +10889,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/recentQueries').replace( + url: (rootUrl + '/v2/{+parent}/logScopes').replace( /([^:]\/)\/+/g, '$1' ), @@ -10913,94 +10904,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Folders$Locations$Recentqueries$List - extends StandardParameters { - /** - * Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") - */ - filter?: string; - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my-project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. - */ - parent?: string; - } - - export class Resource$Folders$Locations$Savedqueries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new SavedQuery for the user making the request. + * Updates a log 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. */ - create( - params: Params$Resource$Folders$Locations$Savedqueries$Create, + patch( + params: Params$Resource$Folders$Locations$Logscopes$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Folders$Locations$Savedqueries$Create, + patch( + params?: Params$Resource$Folders$Locations$Logscopes$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Folders$Locations$Savedqueries$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Folders$Locations$Logscopes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Folders$Locations$Savedqueries$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Folders$Locations$Logscopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Folders$Locations$Savedqueries$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Folders$Locations$Logscopes$Patch, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Folders$Locations$Savedqueries$Create - | BodyResponseCallback + | Params$Resource$Folders$Locations$Logscopes$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$Folders$Locations$Savedqueries$Create; + {}) as Params$Resource$Folders$Locations$Logscopes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Savedqueries$Create; + params = {} as Params$Resource$Folders$Locations$Logscopes$Patch; options = {}; } @@ -11013,64 +10977,130 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/savedQueries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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$Folders$Locations$Logscopes$Create + extends StandardParameters { /** - * Deletes an existing SavedQuery that was created by the user making the request. + * Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. + */ + logScopeId?: string; + /** + * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogScope; + } + export interface Params$Resource$Folders$Locations$Logscopes$Delete + extends StandardParameters { + /** + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Logscopes$Get + extends StandardParameters { + /** + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Logscopes$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" + */ + parent?: string; + } + export interface Params$Resource$Folders$Locations$Logscopes$Patch + extends StandardParameters { + /** + * Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope + */ + name?: string; + /** + * Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogScope; + } + + 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. */ - delete( - params: Params$Resource$Folders$Locations$Savedqueries$Delete, + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Folders$Locations$Savedqueries$Delete, + cancel( + params?: Params$Resource$Folders$Locations$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Folders$Locations$Savedqueries$Delete, + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Folders$Locations$Savedqueries$Delete, + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Folders$Locations$Savedqueries$Delete, + cancel( + params: Params$Resource$Folders$Locations$Operations$Cancel, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Folders$Locations$Savedqueries$Delete + | Params$Resource$Folders$Locations$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11083,12 +11113,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Locations$Savedqueries$Delete; + {}) as Params$Resource$Folders$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Savedqueries$Delete; + params = {} as Params$Resource$Folders$Locations$Operations$Cancel; options = {}; } @@ -11101,8 +11131,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -11123,7 +11153,7 @@ export namespace logging_v2 { } /** - * Returns all data associated with the requested query. + * 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`. @@ -11131,49 +11161,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Folders$Locations$Savedqueries$Get, + params: Params$Resource$Folders$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Folders$Locations$Savedqueries$Get, + params?: Params$Resource$Folders$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Folders$Locations$Savedqueries$Get, + params: Params$Resource$Folders$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Folders$Locations$Savedqueries$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Folders$Locations$Savedqueries$Get, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Folders$Locations$Savedqueries$Get - | BodyResponseCallback + | Params$Resource$Folders$Locations$Operations$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$Folders$Locations$Savedqueries$Get; + {}) as Params$Resource$Folders$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Savedqueries$Get; + params = {} as Params$Resource$Folders$Locations$Operations$Get; options = {}; } @@ -11198,17 +11228,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the SavedQueries that were created by the user making 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`. @@ -11216,54 +11246,54 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Folders$Locations$Savedqueries$List, + params: Params$Resource$Folders$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Folders$Locations$Savedqueries$List, + params?: Params$Resource$Folders$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Folders$Locations$Savedqueries$List, + params: Params$Resource$Folders$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Locations$Savedqueries$List, + params: Params$Resource$Folders$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Locations$Savedqueries$List, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Operations$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Folders$Locations$Savedqueries$List - | BodyResponseCallback + | Params$Resource$Folders$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$Folders$Locations$Savedqueries$List; + {}) as Params$Resource$Folders$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Savedqueries$List; + params = {} as Params$Resource$Folders$Locations$Operations$List; options = {}; } @@ -11276,7 +11306,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/savedQueries').replace( + url: (rootUrl + '/v2/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -11286,230 +11316,125 @@ export namespace logging_v2 { 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$Folders$Locations$Operations$Cancel + extends StandardParameters { /** - * Updates an existing SavedQuery. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 cancelled. */ - patch( - params: Params$Resource$Folders$Locations$Savedqueries$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Folders$Locations$Savedqueries$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Folders$Locations$Savedqueries$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Folders$Locations$Savedqueries$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Folders$Locations$Savedqueries$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Folders$Locations$Savedqueries$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Locations$Savedqueries$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Savedqueries$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.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$Savedqueries$Create - extends StandardParameters { - /** - * Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global" "organizations/123456789/locations/us-central1" - */ - parent?: string; - /** - * Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. - */ - savedQueryId?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$SavedQuery; - } - export interface Params$Resource$Folders$Locations$Savedqueries$Delete - extends StandardParameters { - /** - * Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" - */ - name?: string; + requestBody?: Schema$CancelOperationRequest; } - export interface Params$Resource$Folders$Locations$Savedqueries$Get + export interface Params$Resource$Folders$Locations$Operations$Get extends StandardParameters { /** - * Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Folders$Locations$Savedqueries$List + export interface Params$Resource$Folders$Locations$Operations$List extends StandardParameters { /** - * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + * The standard list filter. */ filter?: string; /** - * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" - */ - parent?: string; - } - export interface Params$Resource$Folders$Locations$Savedqueries$Patch - extends StandardParameters { - /** - * Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket-regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. + * The name of the operation's parent resource. */ name?: string; /** - * Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". + * The standard list page size. */ - updateMask?: string; - + pageSize?: number; /** - * Request body metadata + * The standard list page token. */ - requestBody?: Schema$SavedQuery; + pageToken?: string; } - export class Resource$Folders$Logs { + export class Resource$Folders$Locations$Recentqueries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * Lists the RecentQueries that were created by the user making 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. */ - delete( - params: Params$Resource$Folders$Logs$Delete, + list( + params: Params$Resource$Folders$Locations$Recentqueries$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Folders$Logs$Delete, + list( + params?: Params$Resource$Folders$Locations$Recentqueries$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Folders$Logs$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Folders$Locations$Recentqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Folders$Logs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Folders$Locations$Recentqueries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Folders$Logs$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Folders$Locations$Recentqueries$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Folders$Logs$Delete - | BodyResponseCallback + | Params$Resource$Folders$Locations$Recentqueries$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$Folders$Logs$Delete; + {}) as Params$Resource$Folders$Locations$Recentqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Logs$Delete; + params = {} as Params$Resource$Folders$Locations$Recentqueries$List; options = {}; } @@ -11522,79 +11447,109 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+parent}/recentQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + 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$Folders$Locations$Recentqueries$List + extends StandardParameters { /** - * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") + */ + filter?: string; + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my-project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. + */ + parent?: string; + } + + export class Resource$Folders$Locations$Savedqueries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new SavedQuery for the user making 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$Folders$Logs$List, + create( + params: Params$Resource$Folders$Locations$Savedqueries$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Folders$Logs$List, + create( + params?: Params$Resource$Folders$Locations$Savedqueries$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Folders$Logs$List, + ): GaxiosPromise; + create( + params: Params$Resource$Folders$Locations$Savedqueries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Folders$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Folders$Locations$Savedqueries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Folders$Logs$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Folders$Locations$Savedqueries$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Folders$Logs$List - | BodyResponseCallback + | Params$Resource$Folders$Locations$Savedqueries$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$Folders$Logs$List; + {}) as Params$Resource$Folders$Locations$Savedqueries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Logs$List; + params = {} as Params$Resource$Folders$Locations$Savedqueries$Create; options = {}; } @@ -11607,8 +11562,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+parent}/savedQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -11619,139 +11577,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Folders$Logs$Delete - extends StandardParameters { - /** - * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. - */ - logName?: string; - } - export interface Params$Resource$Folders$Logs$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] - */ - parent?: string; - /** - * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. - */ - resourceNames?: string[]; - } - - export class Resource$Folders$Sinks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Sinks$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Folders$Sinks$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Folders$Sinks$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Folders$Sinks$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Folders$Sinks$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Folders$Sinks$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Sinks$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+parent}/sinks').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); } } /** - * Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. + * Deletes an existing SavedQuery that was created by the user making the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11759,31 +11595,31 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Folders$Sinks$Delete, + params: Params$Resource$Folders$Locations$Savedqueries$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Folders$Sinks$Delete, + params?: Params$Resource$Folders$Locations$Savedqueries$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Folders$Sinks$Delete, + params: Params$Resource$Folders$Locations$Savedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Folders$Sinks$Delete, + params: Params$Resource$Folders$Locations$Savedqueries$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Folders$Sinks$Delete, + params: Params$Resource$Folders$Locations$Savedqueries$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Folders$Sinks$Delete + | Params$Resource$Folders$Locations$Savedqueries$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11796,12 +11632,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Sinks$Delete; + {}) as Params$Resource$Folders$Locations$Savedqueries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$Delete; + params = {} as Params$Resource$Folders$Locations$Savedqueries$Delete; options = {}; } @@ -11814,15 +11650,15 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -11836,7 +11672,7 @@ export namespace logging_v2 { } /** - * Gets a sink. + * Returns all data associated with the requested query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11844,49 +11680,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Folders$Sinks$Get, + params: Params$Resource$Folders$Locations$Savedqueries$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Folders$Sinks$Get, + params?: Params$Resource$Folders$Locations$Savedqueries$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Folders$Sinks$Get, + params: Params$Resource$Folders$Locations$Savedqueries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Folders$Sinks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Folders$Sinks$Get, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Folders$Sinks$Get - | BodyResponseCallback + | Params$Resource$Folders$Locations$Savedqueries$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$Folders$Sinks$Get; + {}) as Params$Resource$Folders$Locations$Savedqueries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$Get; + params = {} as Params$Resource$Folders$Locations$Savedqueries$Get; options = {}; } @@ -11899,29 +11735,29 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists sinks. + * Lists the SavedQueries that were created by the user making the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11929,52 +11765,54 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Folders$Sinks$List, + params: Params$Resource$Folders$Locations$Savedqueries$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Folders$Sinks$List, + params?: Params$Resource$Folders$Locations$Savedqueries$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Folders$Sinks$List, + params: Params$Resource$Folders$Locations$Savedqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Sinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Sinks$List, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Folders$Sinks$List - | BodyResponseCallback + | Params$Resource$Folders$Locations$Savedqueries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Sinks$List; + {}) as Params$Resource$Folders$Locations$Savedqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$List; + params = {} as Params$Resource$Folders$Locations$Savedqueries$List; options = {}; } @@ -11987,7 +11825,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/sinks').replace( + url: (rootUrl + '/v2/{+parent}/savedQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -12002,17 +11840,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field. + * Updates an existing SavedQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12020,49 +11858,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Folders$Sinks$Patch, + params: Params$Resource$Folders$Locations$Savedqueries$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Folders$Sinks$Patch, + params?: Params$Resource$Folders$Locations$Savedqueries$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Folders$Sinks$Patch, + params: Params$Resource$Folders$Locations$Savedqueries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Folders$Sinks$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Folders$Sinks$Patch, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Savedqueries$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Folders$Sinks$Patch - | BodyResponseCallback + | Params$Resource$Folders$Locations$Savedqueries$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$Folders$Sinks$Patch; + {}) as Params$Resource$Folders$Locations$Savedqueries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$Patch; + params = {} as Params$Resource$Folders$Locations$Savedqueries$Patch; options = {}; } @@ -12075,155 +11913,66 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity 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. - */ - update( - params: Params$Resource$Folders$Sinks$Update, - options: StreamMethodOptions - ): GaxiosPromise; - update( - params?: Params$Resource$Folders$Sinks$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Folders$Sinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Folders$Sinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Folders$Sinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Folders$Sinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Sinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Sinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + 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$Folders$Sinks$Create + export interface Params$Resource$Folders$Locations$Savedqueries$Create extends StandardParameters { /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. - */ - customWriterIdentity?: string; - /** - * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" + * Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global" "organizations/123456789/locations/us-central1" */ parent?: string; /** - * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. + * Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. */ - uniqueWriterIdentity?: boolean; + savedQueryId?: string; /** * Request body metadata */ - requestBody?: Schema$LogSink; + requestBody?: Schema$SavedQuery; } - export interface Params$Resource$Folders$Sinks$Delete + export interface Params$Resource$Folders$Locations$Savedqueries$Delete extends StandardParameters { /** - * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + * Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" */ - sinkName?: string; + name?: string; } - export interface Params$Resource$Folders$Sinks$Get + export interface Params$Resource$Folders$Locations$Savedqueries$Get extends StandardParameters { /** - * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + * Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" */ - sinkName?: string; + name?: string; } - export interface Params$Resource$Folders$Sinks$List + export interface Params$Resource$Folders$Locations$Savedqueries$List extends StandardParameters { /** - * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED */ filter?: string; /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** @@ -12231,120 +11980,85 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" */ parent?: string; } - export interface Params$Resource$Folders$Sinks$Patch - extends StandardParameters { - /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. - */ - customWriterIdentity?: string; - /** - * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" - */ - sinkName?: string; - /** - * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. - */ - uniqueWriterIdentity?: boolean; - /** - * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogSink; - } - export interface Params$Resource$Folders$Sinks$Update + export interface Params$Resource$Folders$Locations$Savedqueries$Patch extends StandardParameters { /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. - */ - customWriterIdentity?: string; - /** - * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" - */ - sinkName?: string; - /** - * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. + * Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket-regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. */ - uniqueWriterIdentity?: boolean; + name?: string; /** - * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + * Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogSink; + requestBody?: Schema$SavedQuery; } - export class Resource$Locations { + export class Resource$Folders$Logs { context: APIRequestContext; - buckets: Resource$Locations$Buckets; - operations: Resource$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; - this.buckets = new Resource$Locations$Buckets(this.context); - this.operations = new Resource$Locations$Operations(this.context); } /** - * Gets information about a location. + * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Locations$Get, + delete( + params: Params$Resource$Folders$Logs$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Locations$Get, + delete( + params?: Params$Resource$Folders$Logs$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Locations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Logs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Logs$Delete, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Locations$Get - | BodyResponseCallback + | Params$Resource$Folders$Logs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Locations$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Logs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Get; + params = {} as Params$Resource$Folders$Logs$Delete; options = {}; } @@ -12357,29 +12071,29 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['logName'], + pathParams: ['logName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12387,53 +12101,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Locations$List, + params: Params$Resource$Folders$Logs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Locations$List, + params?: Params$Resource$Folders$Logs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Locations$List, + params: Params$Resource$Folders$Logs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Folders$Logs$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Locations$List - | BodyResponseCallback + | Params$Resource$Folders$Logs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Locations$List; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Logs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$List; + params = {} as Params$Resource$Folders$Logs$List; options = {}; } @@ -12446,68 +12156,63 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v2/{+parent}/logs').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$Locations$Get extends StandardParameters { + export interface Params$Resource$Folders$Logs$Delete + extends StandardParameters { /** - * Resource name for the location. + * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. */ - name?: string; + logName?: string; } - export interface Params$Resource$Locations$List extends StandardParameters { + export interface Params$Resource$Folders$Logs$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. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ - filter?: string; + pageSize?: number; /** - * The resource that owns the locations collection, if applicable. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ - name?: string; + pageToken?: string; /** - * The maximum number of results to return. If not set, the service selects a default. + * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] */ - pageSize?: number; + parent?: string; /** - * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. */ - pageToken?: string; + resourceNames?: string[]; } - export class Resource$Locations$Buckets { + export class Resource$Folders$Sinks { context: APIRequestContext; - links: Resource$Locations$Buckets$Links; - views: Resource$Locations$Buckets$Views; constructor(context: APIRequestContext) { this.context = context; - this.links = new Resource$Locations$Buckets$Links(this.context); - this.views = new Resource$Locations$Buckets$Views(this.context); } /** - * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. + * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12515,49 +12220,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Locations$Buckets$Create, + params: Params$Resource$Folders$Sinks$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Locations$Buckets$Create, + params?: Params$Resource$Folders$Sinks$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Locations$Buckets$Create, + params: Params$Resource$Folders$Sinks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Locations$Buckets$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Locations$Buckets$Create, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Create - | BodyResponseCallback + | Params$Resource$Folders$Sinks$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$Locations$Buckets$Create; + {}) as Params$Resource$Folders$Sinks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Create; + params = {} as Params$Resource$Folders$Sinks$Create; options = {}; } @@ -12570,7 +12275,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( + url: (rootUrl + '/v2/{+parent}/sinks').replace( /([^:]\/)\/+/g, '$1' ), @@ -12585,67 +12290,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. + * Deletes a sink. If the sink has a unique writer_identity, then that service account is also 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. */ - createAsync( - params: Params$Resource$Locations$Buckets$Createasync, + delete( + params: Params$Resource$Folders$Sinks$Delete, options: StreamMethodOptions ): GaxiosPromise; - createAsync( - params?: Params$Resource$Locations$Buckets$Createasync, + delete( + params?: Params$Resource$Folders$Sinks$Delete, options?: MethodOptions - ): GaxiosPromise; - createAsync( - params: Params$Resource$Locations$Buckets$Createasync, + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Sinks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Locations$Buckets$Createasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Sinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Locations$Buckets$Createasync, - callback: BodyResponseCallback + delete( + params: Params$Resource$Folders$Sinks$Delete, + callback: BodyResponseCallback ): void; - createAsync(callback: BodyResponseCallback): void; - createAsync( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Createasync - | BodyResponseCallback + | Params$Resource$Folders$Sinks$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$Locations$Buckets$Createasync; + {}) as Params$Resource$Folders$Sinks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Createasync; + params = {} as Params$Resource$Folders$Sinks$Delete; options = {}; } @@ -12658,82 +12363,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets:createAsync').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. + * Gets a sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Locations$Buckets$Delete, + get( + params: Params$Resource$Folders$Sinks$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Locations$Buckets$Delete, + get( + params?: Params$Resource$Folders$Sinks$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Locations$Buckets$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Sinks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Folders$Sinks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Folders$Sinks$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Delete - | BodyResponseCallback + | Params$Resource$Folders$Sinks$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$Locations$Buckets$Delete; + {}) as Params$Resource$Folders$Sinks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Delete; + params = {} as Params$Resource$Folders$Sinks$Get; options = {}; } @@ -12746,114 +12448,29 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a log 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. - */ - get( - params: Params$Resource$Locations$Buckets$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Locations$Buckets$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Locations$Buckets$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Locations$Buckets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Locations$Buckets$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Locations$Buckets$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.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 log buckets. + * Lists sinks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12861,52 +12478,52 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Locations$Buckets$List, + params: Params$Resource$Folders$Sinks$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Locations$Buckets$List, + params?: Params$Resource$Folders$Sinks$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Locations$Buckets$List, + params: Params$Resource$Folders$Sinks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Locations$Buckets$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Locations$Buckets$List, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Locations$Buckets$List - | BodyResponseCallback + | Params$Resource$Folders$Sinks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$List; + {}) as Params$Resource$Folders$Sinks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$List; + params = {} as Params$Resource$Folders$Sinks$List; options = {}; } @@ -12919,7 +12536,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( + url: (rootUrl + '/v2/{+parent}/sinks').replace( /([^:]\/)\/+/g, '$1' ), @@ -12934,17 +12551,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12952,49 +12569,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Locations$Buckets$Patch, + params: Params$Resource$Folders$Sinks$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Locations$Buckets$Patch, + params?: Params$Resource$Folders$Sinks$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Locations$Buckets$Patch, + params: Params$Resource$Folders$Sinks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Locations$Buckets$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Locations$Buckets$Patch, - callback: BodyResponseCallback + params: Params$Resource$Folders$Sinks$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Patch - | BodyResponseCallback + | Params$Resource$Folders$Sinks$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$Locations$Buckets$Patch; + {}) as Params$Resource$Folders$Sinks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Patch; + params = {} as Params$Resource$Folders$Sinks$Patch; options = {}; } @@ -13007,79 +12624,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. + * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity 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. */ - undelete( - params: Params$Resource$Locations$Buckets$Undelete, + update( + params: Params$Resource$Folders$Sinks$Update, options: StreamMethodOptions ): GaxiosPromise; - undelete( - params?: Params$Resource$Locations$Buckets$Undelete, + update( + params?: Params$Resource$Folders$Sinks$Update, options?: MethodOptions - ): GaxiosPromise; - undelete( - params: Params$Resource$Locations$Buckets$Undelete, + ): GaxiosPromise; + update( + params: Params$Resource$Folders$Sinks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Locations$Buckets$Undelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + update( + params: Params$Resource$Folders$Sinks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Locations$Buckets$Undelete, - callback: BodyResponseCallback + update( + params: Params$Resource$Folders$Sinks$Update, + callback: BodyResponseCallback ): void; - undelete(callback: BodyResponseCallback): void; - undelete( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Undelete - | BodyResponseCallback + | Params$Resource$Folders$Sinks$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Undelete; + {}) as Params$Resource$Folders$Sinks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Undelete; + params = {} as Params$Resource$Folders$Sinks$Update; options = {}; } @@ -13092,167 +12709,68 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:undelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Folders$Sinks$Create + extends StandardParameters { /** - * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. */ - updateAsync( - params: Params$Resource$Locations$Buckets$Updateasync, - options: StreamMethodOptions - ): GaxiosPromise; - updateAsync( - params?: Params$Resource$Locations$Buckets$Updateasync, - options?: MethodOptions - ): GaxiosPromise; - updateAsync( - params: Params$Resource$Locations$Buckets$Updateasync, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAsync( - params: Params$Resource$Locations$Buckets$Updateasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAsync( - params: Params$Resource$Locations$Buckets$Updateasync, - callback: BodyResponseCallback - ): void; - updateAsync(callback: BodyResponseCallback): void; - updateAsync( - paramsOrCallback?: - | Params$Resource$Locations$Buckets$Updateasync - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Updateasync; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Updateasync; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+name}:updateAsync').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$Locations$Buckets$Create - extends StandardParameters { + customWriterIdentity?: string; /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" */ - bucketId?: string; + parent?: string; /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. */ - parent?: string; + uniqueWriterIdentity?: boolean; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$LogSink; } - export interface Params$Resource$Locations$Buckets$Createasync + export interface Params$Resource$Folders$Sinks$Delete extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. - */ - bucketId?: string; - /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" - */ - parent?: string; - - /** - * Request body metadata + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" */ - requestBody?: Schema$LogBucket; + sinkName?: string; } - export interface Params$Resource$Locations$Buckets$Delete + export interface Params$Resource$Folders$Sinks$Get extends StandardParameters { /** - * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" */ - name?: string; + sinkName?: string; } - export interface Params$Resource$Locations$Buckets$Get + export interface Params$Resource$Folders$Sinks$List extends StandardParameters { /** - * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. */ - name?: string; - } - export interface Params$Resource$Locations$Buckets$List - extends StandardParameters { + filter?: string; /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -13262,113 +12780,120 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } - export interface Params$Resource$Locations$Buckets$Patch + export interface Params$Resource$Folders$Sinks$Patch extends StandardParameters { /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. */ - name?: string; + customWriterIdentity?: string; /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + */ + sinkName?: string; + /** + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. + */ + uniqueWriterIdentity?: boolean; + /** + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$LogSink; } - export interface Params$Resource$Locations$Buckets$Undelete + export interface Params$Resource$Folders$Sinks$Update extends StandardParameters { /** - * Required. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. */ - name?: string; - + customWriterIdentity?: string; /** - * Request body metadata + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" */ - requestBody?: Schema$UndeleteBucketRequest; - } - export interface Params$Resource$Locations$Buckets$Updateasync - extends StandardParameters { + sinkName?: string; /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. */ - name?: string; + uniqueWriterIdentity?: boolean; /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$LogSink; } - export class Resource$Locations$Buckets$Links { + export class Resource$Locations { context: APIRequestContext; + buckets: Resource$Locations$Buckets; + operations: Resource$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.buckets = new Resource$Locations$Buckets(this.context); + this.operations = new Resource$Locations$Operations(this.context); } /** - * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. + * 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. */ - create( - params: Params$Resource$Locations$Buckets$Links$Create, + get( + params: Params$Resource$Locations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Locations$Buckets$Links$Create, + get( + params?: Params$Resource$Locations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Locations$Buckets$Links$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Locations$Buckets$Links$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Locations$Buckets$Links$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Links$Create - | BodyResponseCallback + | Params$Resource$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Links$Create; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Links$Create; + params = {} as Params$Resource$Locations$Get; options = {}; } @@ -13381,82 +12906,83 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/links').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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 link. This will also delete the corresponding BigQuery linked dataset. + * 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. */ - delete( - params: Params$Resource$Locations$Buckets$Links$Delete, + list( + params: Params$Resource$Locations$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Locations$Buckets$Links$Delete, + list( + params?: Params$Resource$Locations$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Locations$Buckets$Links$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Links$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Links$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Links$Delete - | BodyResponseCallback + | Params$Resource$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Links$Delete; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Links$Delete; + params = {} as Params$Resource$Locations$List; options = {}; } @@ -13469,8 +12995,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -13481,67 +13010,103 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Locations$Get extends StandardParameters { /** - * Gets a link. + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Locations$List extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Locations$Buckets { + context: APIRequestContext; + links: Resource$Locations$Buckets$Links; + views: Resource$Locations$Buckets$Views; + constructor(context: APIRequestContext) { + this.context = context; + this.links = new Resource$Locations$Buckets$Links(this.context); + this.views = new Resource$Locations$Buckets$Views(this.context); + } + + /** + * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Locations$Buckets$Links$Get, + create( + params: Params$Resource$Locations$Buckets$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Locations$Buckets$Links$Get, + create( + params?: Params$Resource$Locations$Buckets$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Locations$Buckets$Links$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Locations$Buckets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Buckets$Links$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Buckets$Links$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Links$Get - | BodyResponseCallback + | Params$Resource$Locations$Buckets$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$Locations$Buckets$Links$Get; + {}) as Params$Resource$Locations$Buckets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Links$Get; + params = {} as Params$Resource$Locations$Buckets$Create; options = {}; } @@ -13554,82 +13119,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+parent}/buckets').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 links. + * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Locations$Buckets$Links$List, + createAsync( + params: Params$Resource$Locations$Buckets$Createasync, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Locations$Buckets$Links$List, + createAsync( + params?: Params$Resource$Locations$Buckets$Createasync, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Locations$Buckets$Links$List, + ): GaxiosPromise; + createAsync( + params: Params$Resource$Locations$Buckets$Createasync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Buckets$Links$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + createAsync( + params: Params$Resource$Locations$Buckets$Createasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Buckets$Links$List, - callback: BodyResponseCallback + createAsync( + params: Params$Resource$Locations$Buckets$Createasync, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + createAsync(callback: BodyResponseCallback): void; + createAsync( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Links$List - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Createasync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Links$List; + {}) as Params$Resource$Locations$Buckets$Createasync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Links$List; + params = {} as Params$Resource$Locations$Buckets$Createasync; options = {}; } @@ -13642,11 +13207,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/links').replace( + url: (rootUrl + '/v2/{+parent}/buckets:createAsync').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -13657,120 +13222,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Locations$Buckets$Links$Create - extends StandardParameters { - /** - * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. - */ - 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]" - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Link; - } - export interface Params$Resource$Locations$Buckets$Links$Delete - extends StandardParameters { - /** - * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Locations$Buckets$Links$Get - extends StandardParameters { - /** - * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Locations$Buckets$Links$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. - */ - pageToken?: string; - /** - * Required. The parent resource whose links are to be listed: "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]" - */ - parent?: string; - } - - export class Resource$Locations$Buckets$Views { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. + * Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently 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. */ - create( - params: Params$Resource$Locations$Buckets$Views$Create, + delete( + params: Params$Resource$Locations$Buckets$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Locations$Buckets$Views$Create, + delete( + params?: Params$Resource$Locations$Buckets$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Locations$Buckets$Views$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Locations$Buckets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Locations$Buckets$Views$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Locations$Buckets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Locations$Buckets$Views$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Locations$Buckets$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Create - | BodyResponseCallback + | Params$Resource$Locations$Buckets$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$Locations$Buckets$Views$Create; + {}) as Params$Resource$Locations$Buckets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Create; + params = {} as Params$Resource$Locations$Buckets$Delete; options = {}; } @@ -13783,82 +13295,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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 view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. + * Gets a log 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. */ - delete( - params: Params$Resource$Locations$Buckets$Views$Delete, + get( + params: Params$Resource$Locations$Buckets$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Locations$Buckets$Views$Delete, + get( + params?: Params$Resource$Locations$Buckets$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Locations$Buckets$Views$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Locations$Buckets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Views$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Locations$Buckets$Views$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Delete - | BodyResponseCallback + | Params$Resource$Locations$Buckets$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$Locations$Buckets$Views$Delete; + {}) as Params$Resource$Locations$Buckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Delete; + params = {} as Params$Resource$Locations$Buckets$Get; options = {}; } @@ -13872,7 +13381,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -13883,67 +13392,70 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a view on a log bucket. + * Lists log buckets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Locations$Buckets$Views$Get, + list( + params: Params$Resource$Locations$Buckets$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Locations$Buckets$Views$Get, + list( + params?: Params$Resource$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Locations$Buckets$Views$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Locations$Buckets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Buckets$Views$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Buckets$Views$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Get - | BodyResponseCallback + | Params$Resource$Locations$Buckets$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$Locations$Buckets$Views$Get; + {}) as Params$Resource$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Get; + params = {} as Params$Resource$Locations$Buckets$List; options = {}; } @@ -13956,79 +13468,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/buckets').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 access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Locations$Buckets$Views$Getiampolicy, + patch( + params: Params$Resource$Locations$Buckets$Patch, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Locations$Buckets$Views$Getiampolicy, + patch( + params?: Params$Resource$Locations$Buckets$Patch, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Getiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Locations$Buckets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Getiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Locations$Buckets$Patch, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Getiampolicy - | BodyResponseCallback + | Params$Resource$Locations$Buckets$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$Locations$Buckets$Views$Getiampolicy; + {}) as Params$Resource$Locations$Buckets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Getiampolicy; + params = {} as Params$Resource$Locations$Buckets$Patch; options = {}; } @@ -14041,85 +13556,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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); } } /** - * Lists views on a log bucket. + * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Locations$Buckets$Views$List, + undelete( + params: Params$Resource$Locations$Buckets$Undelete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Locations$Buckets$Views$List, + undelete( + params?: Params$Resource$Locations$Buckets$Undelete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Locations$Buckets$Views$List, + ): GaxiosPromise; + undelete( + params: Params$Resource$Locations$Buckets$Undelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Buckets$Views$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + undelete( + params: Params$Resource$Locations$Buckets$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Buckets$Views$List, - callback: BodyResponseCallback + undelete( + params: Params$Resource$Locations$Buckets$Undelete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + undelete(callback: BodyResponseCallback): void; + undelete( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$List - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Undelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Views$List; + {}) as Params$Resource$Locations$Buckets$Undelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$List; + params = {} as Params$Resource$Locations$Buckets$Undelete; options = {}; } @@ -14132,82 +13641,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( + url: (rootUrl + '/v2/{+name}:undelete').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. + * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Locations$Buckets$Views$Patch, + updateAsync( + params: Params$Resource$Locations$Buckets$Updateasync, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Locations$Buckets$Views$Patch, + updateAsync( + params?: Params$Resource$Locations$Buckets$Updateasync, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Locations$Buckets$Views$Patch, + ): GaxiosPromise; + updateAsync( + params: Params$Resource$Locations$Buckets$Updateasync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Locations$Buckets$Views$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateAsync( + params: Params$Resource$Locations$Buckets$Updateasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Locations$Buckets$Views$Patch, - callback: BodyResponseCallback + updateAsync( + params: Params$Resource$Locations$Buckets$Updateasync, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + updateAsync(callback: BodyResponseCallback): void; + updateAsync( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Patch - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Updateasync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Locations$Buckets$Views$Patch; + {}) as Params$Resource$Locations$Buckets$Updateasync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Patch; + params = {} as Params$Resource$Locations$Buckets$Updateasync; options = {}; } @@ -14220,8 +13729,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v2/{+name}:updateAsync').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -14232,67 +13744,180 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Locations$Buckets$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + */ + bucketId?: string; + /** + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Locations$Buckets$Createasync + extends StandardParameters { + /** + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + */ + bucketId?: string; + /** + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Locations$Buckets$Delete + extends StandardParameters { + /** + * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + } + export interface Params$Resource$Locations$Buckets$Get + extends StandardParameters { + /** + * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + } + export interface Params$Resource$Locations$Buckets$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; + } + export interface Params$Resource$Locations$Buckets$Patch + extends StandardParameters { + /** + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Locations$Buckets$Undelete + extends StandardParameters { + /** + * Required. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UndeleteBucketRequest; + } + export interface Params$Resource$Locations$Buckets$Updateasync + extends StandardParameters { + /** + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + + export class Resource$Locations$Buckets$Links { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Setiampolicy, + create( + params: Params$Resource$Locations$Buckets$Links$Create, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Locations$Buckets$Views$Setiampolicy, + create( + params?: Params$Resource$Locations$Buckets$Links$Create, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Setiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Locations$Buckets$Links$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Links$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Locations$Buckets$Views$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Links$Create, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Setiampolicy - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Links$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$Locations$Buckets$Views$Setiampolicy; + {}) as Params$Resource$Locations$Buckets$Links$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Buckets$Views$Setiampolicy; + params = {} as Params$Resource$Locations$Buckets$Links$Create; options = {}; } @@ -14305,7 +13930,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v2/{+parent}/links').replace( /([^:]\/)\/+/g, '$1' ), @@ -14315,80 +13940,72 @@ export namespace logging_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); } } /** - * 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 link. This will also delete the corresponding BigQuery linked 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. */ - testIamPermissions( - params: Params$Resource$Locations$Buckets$Views$Testiampermissions, + delete( + params: Params$Resource$Locations$Buckets$Links$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Locations$Buckets$Views$Testiampermissions, + delete( + params?: Params$Resource$Locations$Buckets$Links$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Locations$Buckets$Views$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Locations$Buckets$Links$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Locations$Buckets$Views$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Locations$Buckets$Views$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Locations$Buckets$Links$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Locations$Buckets$Links$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Locations$Buckets$Views$Testiampermissions - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Links$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$Locations$Buckets$Views$Testiampermissions; + {}) as Params$Resource$Locations$Buckets$Links$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Locations$Buckets$Views$Testiampermissions; + params = {} as Params$Resource$Locations$Buckets$Links$Delete; options = {}; } @@ -14401,187 +14018,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:testIamPermissions').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); } } - } - - export interface Params$Resource$Locations$Buckets$Views$Create - extends StandardParameters { - /** - * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - parent?: string; - /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. - */ - viewId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogView; - } - export interface Params$Resource$Locations$Buckets$Views$Delete - extends StandardParameters { - /** - * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - } - export interface Params$Resource$Locations$Buckets$Views$Get - extends StandardParameters { - /** - * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - } - export interface Params$Resource$Locations$Buckets$Views$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$Locations$Buckets$Views$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" - */ - parent?: string; - } - export interface Params$Resource$Locations$Buckets$Views$Patch - extends StandardParameters { - /** - * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - /** - * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogView; - } - export interface Params$Resource$Locations$Buckets$Views$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$Locations$Buckets$Views$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$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. + * Gets a link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Locations$Operations$Cancel, + get( + params: Params$Resource$Locations$Buckets$Links$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Locations$Operations$Cancel, + get( + params?: Params$Resource$Locations$Buckets$Links$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Locations$Operations$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Locations$Buckets$Links$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Links$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Locations$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Links$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Links$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$Locations$Operations$Cancel; + {}) as Params$Resource$Locations$Buckets$Links$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Operations$Cancel; + params = {} as Params$Resource$Locations$Buckets$Links$Get; options = {}; } @@ -14594,8 +14103,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -14606,67 +14115,70 @@ export namespace logging_v2 { 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 links. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Locations$Operations$Get, + list( + params: Params$Resource$Locations$Buckets$Links$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Locations$Operations$Get, + list( + params?: Params$Resource$Locations$Buckets$Links$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Locations$Buckets$Links$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$Links$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$Links$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Links$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$Locations$Operations$Get; + {}) as Params$Resource$Locations$Buckets$Links$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Operations$Get; + params = {} as Params$Resource$Locations$Buckets$Links$List; options = {}; } @@ -14679,84 +14191,135 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/links').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$Locations$Buckets$Links$Create + extends StandardParameters { /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. + * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. + */ + 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]" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Link; + } + export interface Params$Resource$Locations$Buckets$Links$Delete + extends StandardParameters { + /** + * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" + */ + name?: string; + } + export interface Params$Resource$Locations$Buckets$Links$Get + extends StandardParameters { + /** + * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" + */ + name?: string; + } + export interface Params$Resource$Locations$Buckets$Links$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. + */ + pageToken?: string; + /** + * Required. The parent resource whose links are to be listed: "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]" + */ + parent?: string; + } + + export class Resource$Locations$Buckets$Views { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Locations$Operations$List, + create( + params: Params$Resource$Locations$Buckets$Views$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Locations$Operations$List, + create( + params?: Params$Resource$Locations$Buckets$Views$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Locations$Operations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Locations$Buckets$Views$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Views$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Locations$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Locations$Buckets$Views$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$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$Locations$Operations$List; + {}) as Params$Resource$Locations$Buckets$Views$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Locations$Operations$List; + params = {} as Params$Resource$Locations$Buckets$Views$Create; options = {}; } @@ -14769,78 +14332,32 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/operations').replace( + url: (rootUrl + '/v2/{+parent}/views').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); } } - } - - export interface Params$Resource$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$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$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$Logs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14848,31 +14365,31 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Logs$Delete, + params: Params$Resource$Locations$Buckets$Views$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Logs$Delete, + params?: Params$Resource$Locations$Buckets$Views$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Logs$Delete, + params: Params$Resource$Locations$Buckets$Views$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Logs$Delete, + params: Params$Resource$Locations$Buckets$Views$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Logs$Delete, + params: Params$Resource$Locations$Buckets$Views$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Logs$Delete + | Params$Resource$Locations$Buckets$Views$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14884,12 +14401,13 @@ export namespace logging_v2 { | BodyResponseCallback | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Logs$Delete; + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Buckets$Views$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Logs$Delete; + params = {} as Params$Resource$Locations$Buckets$Views$Delete; options = {}; } @@ -14902,15 +14420,15 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -14924,56 +14442,57 @@ export namespace logging_v2 { } /** - * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * Gets a view on a log 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. */ - list( - params: Params$Resource$Logs$List, + get( + params: Params$Resource$Locations$Buckets$Views$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Logs$List, + get( + params?: Params$Resource$Locations$Buckets$Views$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Logs$List, - options: StreamMethodOptions | BodyResponseCallback, + ): GaxiosPromise; + get( + params: Params$Resource$Locations$Buckets$Views$Get, + options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Views$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Logs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Locations$Buckets$Views$Get, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Logs$List - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Logs$List; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Buckets$Views$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Logs$List; + params = {} as Params$Resource$Locations$Buckets$Views$Get; options = {}; } @@ -14986,118 +14505,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+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$Logs$Delete extends StandardParameters { - /** - * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. - */ - logName?: string; - } - export interface Params$Resource$Logs$List extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] - */ - parent?: string; - /** - * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. - */ - resourceNames?: string[]; - } - - export class Resource$Monitoredresourcedescriptors { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the descriptors for monitored resource types used by Logging. + * 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. */ - list( - params: Params$Resource$Monitoredresourcedescriptors$List, + getIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Monitoredresourcedescriptors$List, + getIamPolicy( + params?: Params$Resource$Locations$Buckets$Views$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Monitoredresourcedescriptors$List, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Getiampolicy, + callback: BodyResponseCallback ): void; - list( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Monitoredresourcedescriptors$List - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$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$Monitoredresourcedescriptors$List; + {}) as Params$Resource$Locations$Buckets$Views$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Monitoredresourcedescriptors$List; + params = {} as Params$Resource$Locations$Buckets$Views$Getiampolicy; options = {}; } @@ -15110,111 +14590,85 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/monitoredResourceDescriptors').replace( + url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [], - pathParams: [], + 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$Monitoredresourcedescriptors$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - } - - export class Resource$Organizations { - context: APIRequestContext; - exclusions: Resource$Organizations$Exclusions; - locations: Resource$Organizations$Locations; - logs: Resource$Organizations$Logs; - sinks: Resource$Organizations$Sinks; - constructor(context: APIRequestContext) { - this.context = context; - this.exclusions = new Resource$Organizations$Exclusions(this.context); - this.locations = new Resource$Organizations$Locations(this.context); - this.logs = new Resource$Organizations$Logs(this.context); - this.sinks = new Resource$Organizations$Sinks(this.context); - } /** - * Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + * Lists views on a log 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. */ - getCmekSettings( - params: Params$Resource$Organizations$Getcmeksettings, + list( + params: Params$Resource$Locations$Buckets$Views$List, options: StreamMethodOptions ): GaxiosPromise; - getCmekSettings( - params?: Params$Resource$Organizations$Getcmeksettings, + list( + params?: Params$Resource$Locations$Buckets$Views$List, options?: MethodOptions - ): GaxiosPromise; - getCmekSettings( - params: Params$Resource$Organizations$Getcmeksettings, + ): GaxiosPromise; + list( + params: Params$Resource$Locations$Buckets$Views$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getCmekSettings( - params: Params$Resource$Organizations$Getcmeksettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$Views$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getCmekSettings( - params: Params$Resource$Organizations$Getcmeksettings, - callback: BodyResponseCallback + list( + params: Params$Resource$Locations$Buckets$Views$List, + callback: BodyResponseCallback ): void; - getCmekSettings(callback: BodyResponseCallback): void; - getCmekSettings( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Getcmeksettings - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$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$Organizations$Getcmeksettings; + {}) as Params$Resource$Locations$Buckets$Views$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Getcmeksettings; + params = {} as Params$Resource$Locations$Buckets$Views$List; options = {}; } @@ -15227,7 +14681,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/cmekSettings').replace( + url: (rootUrl + '/v2/{+parent}/views').replace( /([^:]\/)\/+/g, '$1' ), @@ -15237,72 +14691,72 @@ export namespace logging_v2 { 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 settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more information. + * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSettings( - params: Params$Resource$Organizations$Getsettings, + patch( + params: Params$Resource$Locations$Buckets$Views$Patch, options: StreamMethodOptions ): GaxiosPromise; - getSettings( - params?: Params$Resource$Organizations$Getsettings, + patch( + params?: Params$Resource$Locations$Buckets$Views$Patch, options?: MethodOptions - ): GaxiosPromise; - getSettings( - params: Params$Resource$Organizations$Getsettings, + ): GaxiosPromise; + patch( + params: Params$Resource$Locations$Buckets$Views$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSettings( - params: Params$Resource$Organizations$Getsettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Locations$Buckets$Views$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSettings( - params: Params$Resource$Organizations$Getsettings, - callback: BodyResponseCallback + patch( + params: Params$Resource$Locations$Buckets$Views$Patch, + callback: BodyResponseCallback ): void; - getSettings(callback: BodyResponseCallback): void; - getSettings( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Organizations$Getsettings - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$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$Organizations$Getsettings; + {}) as Params$Resource$Locations$Buckets$Views$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Getsettings; + params = {} as Params$Resource$Locations$Buckets$Views$Patch; options = {}; } @@ -15315,11 +14769,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/settings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -15330,69 +14781,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings fails when any of the following are true: The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + * 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. */ - updateCmekSettings( - params: Params$Resource$Organizations$Updatecmeksettings, + setIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - updateCmekSettings( - params?: Params$Resource$Organizations$Updatecmeksettings, + setIamPolicy( + params?: Params$Resource$Locations$Buckets$Views$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - updateCmekSettings( - params: Params$Resource$Organizations$Updatecmeksettings, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateCmekSettings( - params: Params$Resource$Organizations$Updatecmeksettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateCmekSettings( - params: Params$Resource$Organizations$Updatecmeksettings, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateCmekSettings( - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Locations$Buckets$Views$Setiampolicy, + callback: BodyResponseCallback ): void; - updateCmekSettings( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Organizations$Updatecmeksettings - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Updatecmeksettings; + {}) as Params$Resource$Locations$Buckets$Views$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Updatecmeksettings; + params = {} as Params$Resource$Locations$Buckets$Views$Setiampolicy; options = {}; } @@ -15405,82 +14854,90 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/cmekSettings').replace( + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + 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); } } /** - * Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information. + * 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. */ - updateSettings( - params: Params$Resource$Organizations$Updatesettings, + testIamPermissions( + params: Params$Resource$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - updateSettings( - params?: Params$Resource$Organizations$Updatesettings, + testIamPermissions( + params?: Params$Resource$Locations$Buckets$Views$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - updateSettings( - params: Params$Resource$Organizations$Updatesettings, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateSettings( - params: Params$Resource$Organizations$Updatesettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Locations$Buckets$Views$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateSettings( - params: Params$Resource$Organizations$Updatesettings, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Locations$Buckets$Views$Testiampermissions, + callback: BodyResponseCallback ): void; - updateSettings(callback: BodyResponseCallback): void; - updateSettings( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Updatesettings - | BodyResponseCallback + | Params$Resource$Locations$Buckets$Views$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Updatesettings; + {}) as Params$Resource$Locations$Buckets$Views$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Updatesettings; + params = + {} as Params$Resource$Locations$Buckets$Views$Testiampermissions; options = {}; } @@ -15493,206 +14950,169 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/settings').replace( + url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + 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$Getcmeksettings + export interface Params$Resource$Locations$Buckets$Views$Create extends StandardParameters { /** - * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. + * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" */ - name?: string; + parent?: string; + /** + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + */ + viewId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogView; } - export interface Params$Resource$Organizations$Getsettings + export interface Params$Resource$Locations$Buckets$Views$Delete extends StandardParameters { /** - * Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. + * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" */ name?: string; } - export interface Params$Resource$Organizations$Updatecmeksettings + export interface Params$Resource$Locations$Buckets$Views$Get extends StandardParameters { /** - * Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. + * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" */ name?: string; + } + export interface Params$Resource$Locations$Buckets$Views$Getiampolicy + extends StandardParameters { /** - * Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" + * 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. */ - updateMask?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$CmekSettings; + requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Organizations$Updatesettings + export interface Params$Resource$Locations$Buckets$Views$List extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + */ + parent?: string; + } + export interface Params$Resource$Locations$Buckets$Views$Patch + extends StandardParameters { + /** + * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" */ name?: string; /** - * Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" + * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$Settings; + requestBody?: Schema$LogView; } + export interface Params$Resource$Locations$Buckets$Views$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$Organizations$Exclusions { + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Locations$Buckets$Views$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$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. + * 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$Organizations$Exclusions$Create, + cancel( + params: Params$Resource$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Exclusions$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Exclusions$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Exclusions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Exclusions$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Exclusions$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+parent}/exclusions').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 exclusion in the _Default sink. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Exclusions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Exclusions$Delete, + cancel( + params?: Params$Resource$Locations$Operations$Cancel, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Exclusions$Delete, + cancel( + params: Params$Resource$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Exclusions$Delete, + cancel( + params: Params$Resource$Locations$Operations$Cancel, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Exclusions$Delete, + cancel( + params: Params$Resource$Locations$Operations$Cancel, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$Delete + | Params$Resource$Locations$Operations$Cancel | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15705,12 +15125,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Exclusions$Delete; + {}) as Params$Resource$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$Delete; + params = {} as Params$Resource$Locations$Operations$Cancel; options = {}; } @@ -15723,8 +15143,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -15745,7 +15165,7 @@ export namespace logging_v2 { } /** - * Gets the description of an exclusion in the _Default sink. + * 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`. @@ -15753,49 +15173,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizations$Exclusions$Get, + params: Params$Resource$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Organizations$Exclusions$Get, + params?: Params$Resource$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Organizations$Exclusions$Get, + params: Params$Resource$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Exclusions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Exclusions$Get, - callback: BodyResponseCallback + params: Params$Resource$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$Get - | BodyResponseCallback + | Params$Resource$Locations$Operations$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$Organizations$Exclusions$Get; + {}) as Params$Resource$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$Get; + params = {} as Params$Resource$Locations$Operations$Get; options = {}; } @@ -15820,17 +15240,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the exclusions on the _Default sink in a parent 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`. @@ -15838,54 +15258,54 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Exclusions$List, + params: Params$Resource$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Exclusions$List, + params?: Params$Resource$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Exclusions$List, + params: Params$Resource$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Exclusions$List, + params: Params$Resource$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Exclusions$List, - callback: BodyResponseCallback + params: Params$Resource$Locations$Operations$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$List - | BodyResponseCallback + | Params$Resource$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$Organizations$Exclusions$List; + {}) as Params$Resource$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$List; + params = {} as Params$Resource$Locations$Operations$List; options = {}; } @@ -15898,7 +15318,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/exclusions').replace( + url: (rootUrl + '/v2/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -15908,72 +15328,117 @@ export namespace logging_v2 { 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$Locations$Operations$Cancel + extends StandardParameters { /** - * Changes one or more properties of an existing exclusion in the _Default sink. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$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$Logs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Organizations$Exclusions$Patch, + delete( + params: Params$Resource$Logs$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Exclusions$Patch, + delete( + params?: Params$Resource$Logs$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Exclusions$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Logs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Exclusions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Exclusions$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Logs$Delete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$Patch - | BodyResponseCallback + | Params$Resource$Logs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Exclusions$Patch; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Logs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$Patch; + params = {} as Params$Resource$Logs$Delete; options = {}; } @@ -15986,158 +15451,78 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['logName'], + pathParams: ['logName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Organizations$Exclusions$Create - extends StandardParameters { - /** - * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogExclusion; - } - export interface Params$Resource$Organizations$Exclusions$Delete - extends StandardParameters { - /** - * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" - */ - name?: string; - } - export interface Params$Resource$Organizations$Exclusions$Get - extends StandardParameters { - /** - * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" - */ - name?: string; - } - export interface Params$Resource$Organizations$Exclusions$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" - */ - parent?: string; - } - export interface Params$Resource$Organizations$Exclusions$Patch - extends StandardParameters { - /** - * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" - */ - name?: string; - /** - * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogExclusion; - } - - export class Resource$Organizations$Locations { - context: APIRequestContext; - buckets: Resource$Organizations$Locations$Buckets; - operations: Resource$Organizations$Locations$Operations; - recentQueries: Resource$Organizations$Locations$Recentqueries; - savedQueries: Resource$Organizations$Locations$Savedqueries; - constructor(context: APIRequestContext) { - this.context = context; - this.buckets = new Resource$Organizations$Locations$Buckets(this.context); - this.operations = new Resource$Organizations$Locations$Operations( - this.context - ); - this.recentQueries = new Resource$Organizations$Locations$Recentqueries( - this.context - ); - this.savedQueries = new Resource$Organizations$Locations$Savedqueries( - this.context - ); - } /** - * Gets information about a location. + * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are 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. */ - get( - params: Params$Resource$Organizations$Locations$Get, + list( + params: Params$Resource$Logs$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Get, + list( + params?: Params$Resource$Logs$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Logs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Logs$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Get - | BodyResponseCallback + | Params$Resource$Logs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Get; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Logs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Get; + params = {} as Params$Resource$Logs$List; options = {}; } @@ -16150,29 +15535,61 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/logs').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$Logs$Delete extends StandardParameters { /** - * Lists information about the supported locations for this service. + * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. + */ + logName?: string; + } + export interface Params$Resource$Logs$List extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + */ + parent?: string; + /** + * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + */ + resourceNames?: string[]; + } + + export class Resource$Monitoredresourcedescriptors { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the descriptors for monitored resource types used by Logging. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16180,54 +15597,56 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Locations$List, + params: Params$Resource$Monitoredresourcedescriptors$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Locations$List, + params?: Params$Resource$Monitoredresourcedescriptors$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Locations$List, + params: Params$Resource$Monitoredresourcedescriptors$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$List, + params: Params$Resource$Monitoredresourcedescriptors$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Monitoredresourcedescriptors$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$List - | BodyResponseCallback + | Params$Resource$Monitoredresourcedescriptors$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$List; + {}) as Params$Resource$Monitoredresourcedescriptors$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$List; + params = {} as Params$Resource$Monitoredresourcedescriptors$List; options = {}; } @@ -16240,7 +15659,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/locations').replace( + url: (rootUrl + '/v2/monitoredResourceDescriptors').replace( /([^:]\/)\/+/g, '$1' ), @@ -16250,114 +15669,101 @@ export namespace logging_v2 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Organizations$Locations$Get - extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$List + export interface Params$Resource$Monitoredresourcedescriptors$List extends StandardParameters { /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; - /** - * The maximum number of results to return. If not set, the service selects a default. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; } - export class Resource$Organizations$Locations$Buckets { + export class Resource$Organizations { context: APIRequestContext; - links: Resource$Organizations$Locations$Buckets$Links; - views: Resource$Organizations$Locations$Buckets$Views; + exclusions: Resource$Organizations$Exclusions; + locations: Resource$Organizations$Locations; + logs: Resource$Organizations$Logs; + sinks: Resource$Organizations$Sinks; constructor(context: APIRequestContext) { this.context = context; - this.links = new Resource$Organizations$Locations$Buckets$Links( - this.context - ); - this.views = new Resource$Organizations$Locations$Buckets$Views( - this.context - ); + this.exclusions = new Resource$Organizations$Exclusions(this.context); + this.locations = new Resource$Organizations$Locations(this.context); + this.logs = new Resource$Organizations$Logs(this.context); + this.sinks = new Resource$Organizations$Sinks(this.context); } /** - * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. + * Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Organizations$Locations$Buckets$Create, + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Buckets$Create, + getCmekSettings( + params?: Params$Resource$Organizations$Getcmeksettings, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Buckets$Create, + ): GaxiosPromise; + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Create, - callback: BodyResponseCallback + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + getCmekSettings(callback: BodyResponseCallback): void; + getCmekSettings( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Create - | BodyResponseCallback + | Params$Resource$Organizations$Getcmeksettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Create; + {}) as Params$Resource$Organizations$Getcmeksettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$Create; + params = {} as Params$Resource$Organizations$Getcmeksettings; options = {}; } @@ -16370,83 +15776,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( + url: (rootUrl + '/v2/{+name}/cmekSettings').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); } } /** - * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. + * Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more information. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createAsync( - params: Params$Resource$Organizations$Locations$Buckets$Createasync, + getSettings( + params: Params$Resource$Organizations$Getsettings, options: StreamMethodOptions ): GaxiosPromise; - createAsync( - params?: Params$Resource$Organizations$Locations$Buckets$Createasync, + getSettings( + params?: Params$Resource$Organizations$Getsettings, options?: MethodOptions - ): GaxiosPromise; - createAsync( - params: Params$Resource$Organizations$Locations$Buckets$Createasync, + ): GaxiosPromise; + getSettings( + params: Params$Resource$Organizations$Getsettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Organizations$Locations$Buckets$Createasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getSettings( + params: Params$Resource$Organizations$Getsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Organizations$Locations$Buckets$Createasync, - callback: BodyResponseCallback + getSettings( + params: Params$Resource$Organizations$Getsettings, + callback: BodyResponseCallback ): void; - createAsync(callback: BodyResponseCallback): void; - createAsync( + getSettings(callback: BodyResponseCallback): void; + getSettings( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Createasync - | BodyResponseCallback + | Params$Resource$Organizations$Getsettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Createasync; + {}) as Params$Resource$Organizations$Getsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Createasync; + params = {} as Params$Resource$Organizations$Getsettings; options = {}; } @@ -16459,82 +15864,84 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets:createAsync').replace( + url: (rootUrl + '/v2/{+name}/settings').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 log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. + * Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings fails when any of the following are true: The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Organizations$Locations$Buckets$Delete, + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Buckets$Delete, + updateCmekSettings( + params?: Params$Resource$Organizations$Updatecmeksettings, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Delete, + ): GaxiosPromise; + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Delete, - callback: BodyResponseCallback + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + updateCmekSettings( + callback: BodyResponseCallback + ): void; + updateCmekSettings( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Updatecmeksettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Delete; + {}) as Params$Resource$Organizations$Updatecmeksettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$Delete; + params = {} as Params$Resource$Organizations$Updatecmeksettings; options = {}; } @@ -16547,8 +15954,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}/cmekSettings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', apiVersion: '', }, options @@ -16559,67 +15969,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a log bucket. + * Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Organizations$Locations$Buckets$Get, + updateSettings( + params: Params$Resource$Organizations$Updatesettings, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Buckets$Get, + updateSettings( + params?: Params$Resource$Organizations$Updatesettings, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Buckets$Get, + ): GaxiosPromise; + updateSettings( + params: Params$Resource$Organizations$Updatesettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Buckets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateSettings( + params: Params$Resource$Organizations$Updatesettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Buckets$Get, - callback: BodyResponseCallback + updateSettings( + params: Params$Resource$Organizations$Updatesettings, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + updateSettings(callback: BodyResponseCallback): void; + updateSettings( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Get - | BodyResponseCallback + | Params$Resource$Organizations$Updatesettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Get; + {}) as Params$Resource$Organizations$Updatesettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$Get; + params = {} as Params$Resource$Organizations$Updatesettings; options = {}; } @@ -16632,8 +16042,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+name}/settings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', apiVersion: '', }, options @@ -16644,70 +16057,121 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Getcmeksettings + extends StandardParameters { /** - * Lists log buckets. + * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. + */ + name?: string; + } + export interface Params$Resource$Organizations$Getsettings + extends StandardParameters { + /** + * Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. + */ + name?: string; + } + export interface Params$Resource$Organizations$Updatecmeksettings + extends StandardParameters { + /** + * Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. + */ + name?: string; + /** + * Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CmekSettings; + } + export interface Params$Resource$Organizations$Updatesettings + extends StandardParameters { + /** + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" + */ + name?: string; + /** + * Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Settings; + } + + export class Resource$Organizations$Exclusions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a 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$Buckets$List, + create( + params: Params$Resource$Organizations$Exclusions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Buckets$List, + create( + params?: Params$Resource$Organizations$Exclusions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Buckets$List, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Exclusions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Exclusions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Exclusions$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$List - | BodyResponseCallback + | Params$Resource$Organizations$Exclusions$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$Organizations$Locations$Buckets$List; + {}) as Params$Resource$Organizations$Exclusions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$List; + params = {} as Params$Resource$Organizations$Exclusions$Create; options = {}; } @@ -16720,11 +16184,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( + url: (rootUrl + '/v2/{+parent}/exclusions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -16735,67 +16199,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * Deletes an exclusion in the _Default sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Patch, + delete( + params: Params$Resource$Organizations$Exclusions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Locations$Buckets$Patch, + delete( + params?: Params$Resource$Organizations$Exclusions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Exclusions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Exclusions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Exclusions$Delete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Exclusions$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$Organizations$Locations$Buckets$Patch; + {}) as Params$Resource$Organizations$Exclusions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$Patch; + params = {} as Params$Resource$Organizations$Exclusions$Delete; options = {}; } @@ -16809,7 +16273,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -16820,67 +16284,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. + * Gets the description of an exclusion in the _Default sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Organizations$Locations$Buckets$Undelete, + get( + params: Params$Resource$Organizations$Exclusions$Get, options: StreamMethodOptions ): GaxiosPromise; - undelete( - params?: Params$Resource$Organizations$Locations$Buckets$Undelete, + get( + params?: Params$Resource$Organizations$Exclusions$Get, options?: MethodOptions - ): GaxiosPromise; - undelete( - params: Params$Resource$Organizations$Locations$Buckets$Undelete, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Exclusions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Organizations$Locations$Buckets$Undelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Exclusions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Organizations$Locations$Buckets$Undelete, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Exclusions$Get, + callback: BodyResponseCallback ): void; - undelete(callback: BodyResponseCallback): void; - undelete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Undelete - | BodyResponseCallback + | Params$Resource$Organizations$Exclusions$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$Organizations$Locations$Buckets$Undelete; + {}) as Params$Resource$Organizations$Exclusions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Buckets$Undelete; + params = {} as Params$Resource$Organizations$Exclusions$Get; options = {}; } @@ -16893,11 +16357,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:undelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -16908,68 +16369,72 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * Lists all the exclusions on the _Default sink in a parent 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. */ - updateAsync( - params: Params$Resource$Organizations$Locations$Buckets$Updateasync, + list( + params: Params$Resource$Organizations$Exclusions$List, options: StreamMethodOptions ): GaxiosPromise; - updateAsync( - params?: Params$Resource$Organizations$Locations$Buckets$Updateasync, + list( + params?: Params$Resource$Organizations$Exclusions$List, options?: MethodOptions - ): GaxiosPromise; - updateAsync( - params: Params$Resource$Organizations$Locations$Buckets$Updateasync, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Exclusions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAsync( - params: Params$Resource$Organizations$Locations$Buckets$Updateasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Exclusions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateAsync( - params: Params$Resource$Organizations$Locations$Buckets$Updateasync, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Exclusions$List, + callback: BodyResponseCallback ): void; - updateAsync(callback: BodyResponseCallback): void; - updateAsync( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Updateasync - | BodyResponseCallback + | Params$Resource$Organizations$Exclusions$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$Organizations$Locations$Buckets$Updateasync; + {}) as Params$Resource$Organizations$Exclusions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Updateasync; + params = {} as Params$Resource$Organizations$Exclusions$List; options = {}; } @@ -16982,78 +16447,143 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:updateAsync').replace( + url: (rootUrl + '/v2/{+parent}/exclusions').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$Organizations$Locations$Buckets$Create - extends StandardParameters { - /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. - */ - bucketId?: string; /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Changes one or more properties of an existing exclusion in the _Default sink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; + patch( + params: Params$Resource$Organizations$Exclusions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Organizations$Exclusions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Exclusions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Exclusions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Exclusions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Exclusions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Exclusions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$LogBucket; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Exclusions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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$Buckets$Createasync + + export interface Params$Resource$Organizations$Exclusions$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. - */ - bucketId?: string; - /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$LogExclusion; } - export interface Params$Resource$Organizations$Locations$Buckets$Delete + export interface Params$Resource$Organizations$Exclusions$Delete extends StandardParameters { /** - * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" */ name?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$Get + export interface Params$Resource$Organizations$Exclusions$Get extends StandardParameters { /** - * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" */ name?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$List + export interface Params$Resource$Organizations$Exclusions$List extends StandardParameters { /** * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. @@ -17064,114 +16594,103 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" */ parent?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$Patch - extends StandardParameters { - /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - name?: string; - /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogBucket; - } - export interface Params$Resource$Organizations$Locations$Buckets$Undelete - extends StandardParameters { - /** - * Required. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UndeleteBucketRequest; - } - export interface Params$Resource$Organizations$Locations$Buckets$Updateasync + export interface Params$Resource$Organizations$Exclusions$Patch extends StandardParameters { /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" */ name?: string; /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$LogExclusion; } - export class Resource$Organizations$Locations$Buckets$Links { + export class Resource$Organizations$Locations { context: APIRequestContext; + buckets: Resource$Organizations$Locations$Buckets; + logScopes: Resource$Organizations$Locations$Logscopes; + operations: Resource$Organizations$Locations$Operations; + recentQueries: Resource$Organizations$Locations$Recentqueries; + savedQueries: Resource$Organizations$Locations$Savedqueries; constructor(context: APIRequestContext) { this.context = context; + this.buckets = new Resource$Organizations$Locations$Buckets(this.context); + this.logScopes = new Resource$Organizations$Locations$Logscopes( + this.context + ); + this.operations = new Resource$Organizations$Locations$Operations( + this.context + ); + this.recentQueries = new Resource$Organizations$Locations$Recentqueries( + this.context + ); + this.savedQueries = new Resource$Organizations$Locations$Savedqueries( + this.context + ); } /** - * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. + * 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. */ - create( - params: Params$Resource$Organizations$Locations$Buckets$Links$Create, + get( + params: Params$Resource$Organizations$Locations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Buckets$Links$Create, + get( + params?: Params$Resource$Organizations$Locations$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Buckets$Links$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Links$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Links$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Links$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$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$Organizations$Locations$Buckets$Links$Create; + {}) as Params$Resource$Organizations$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Links$Create; + params = {} as Params$Resource$Organizations$Locations$Get; options = {}; } @@ -17184,83 +16703,84 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/links').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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 link. This will also delete the corresponding BigQuery linked dataset. + * 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. */ - delete( - params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, + list( + params: Params$Resource$Organizations$Locations$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Buckets$Links$Delete, + list( + params?: Params$Resource$Organizations$Locations$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Links$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$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$Organizations$Locations$Buckets$Links$Delete; + {}) as Params$Resource$Organizations$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Links$Delete; + params = {} as Params$Resource$Organizations$Locations$List; options = {}; } @@ -17273,8 +16793,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -17285,68 +16808,109 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Locations$Get + extends StandardParameters { /** - * Gets a link. + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Organizations$Locations$Buckets { + context: APIRequestContext; + links: Resource$Organizations$Locations$Buckets$Links; + views: Resource$Organizations$Locations$Buckets$Views; + constructor(context: APIRequestContext) { + this.context = context; + this.links = new Resource$Organizations$Locations$Buckets$Links( + this.context + ); + this.views = new Resource$Organizations$Locations$Buckets$Views( + this.context + ); + } + + /** + * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Buckets$Links$Get, + create( + params: Params$Resource$Organizations$Locations$Buckets$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Buckets$Links$Get, + create( + params?: Params$Resource$Organizations$Locations$Buckets$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Buckets$Links$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Buckets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Buckets$Links$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Buckets$Links$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Links$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$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$Organizations$Locations$Buckets$Links$Get; + {}) as Params$Resource$Organizations$Locations$Buckets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Links$Get; + params = {} as Params$Resource$Organizations$Locations$Buckets$Create; options = {}; } @@ -17359,229 +16923,83 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+parent}/buckets').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 links. + * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Buckets$Links$List, + createAsync( + params: Params$Resource$Organizations$Locations$Buckets$Createasync, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Buckets$Links$List, + createAsync( + params?: Params$Resource$Organizations$Locations$Buckets$Createasync, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Buckets$Links$List, + ): GaxiosPromise; + createAsync( + params: Params$Resource$Organizations$Locations$Buckets$Createasync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Links$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + createAsync( + params: Params$Resource$Organizations$Locations$Buckets$Createasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Links$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Links$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Links$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Links$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+parent}/links').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$Buckets$Links$Create - extends StandardParameters { - /** - * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. - */ - 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]" - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Link; - } - export interface Params$Resource$Organizations$Locations$Buckets$Links$Delete - extends StandardParameters { - /** - * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Buckets$Links$Get - extends StandardParameters { - /** - * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Buckets$Links$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. - */ - pageToken?: string; - /** - * Required. The parent resource whose links are to be listed: "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]" - */ - parent?: string; - } - - export class Resource$Organizations$Locations$Buckets$Views { - context: APIRequestContext; - logs: Resource$Organizations$Locations$Buckets$Views$Logs; - constructor(context: APIRequestContext) { - this.context = context; - this.logs = new Resource$Organizations$Locations$Buckets$Views$Logs( - this.context - ); - } - - /** - * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Buckets$Views$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Views$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Buckets$Views$Create, - callback: BodyResponseCallback + createAsync( + params: Params$Resource$Organizations$Locations$Buckets$Createasync, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + createAsync(callback: BodyResponseCallback): void; + createAsync( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Createasync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Views$Create; + {}) as Params$Resource$Organizations$Locations$Buckets$Createasync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Create; + {} as Params$Resource$Organizations$Locations$Buckets$Createasync; options = {}; } @@ -17594,7 +17012,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( + url: (rootUrl + '/v2/{+parent}/buckets:createAsync').replace( /([^:]\/)\/+/g, '$1' ), @@ -17609,17 +17027,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. + * Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17627,31 +17045,31 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + params: Params$Resource$Organizations$Locations$Buckets$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + params?: Params$Resource$Organizations$Locations$Buckets$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + params: Params$Resource$Organizations$Locations$Buckets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + params: Params$Resource$Organizations$Locations$Buckets$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + params: Params$Resource$Organizations$Locations$Buckets$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Delete + | Params$Resource$Organizations$Locations$Buckets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17664,13 +17082,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Views$Delete; + {}) as Params$Resource$Organizations$Locations$Buckets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Delete; + params = {} as Params$Resource$Organizations$Locations$Buckets$Delete; options = {}; } @@ -17705,7 +17122,7 @@ export namespace logging_v2 { } /** - * Gets a view on a log bucket. + * Gets a log bucket. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17713,50 +17130,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizations$Locations$Buckets$Views$Get, + params: Params$Resource$Organizations$Locations$Buckets$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Get, + params?: Params$Resource$Organizations$Locations$Buckets$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Organizations$Locations$Buckets$Views$Get, + params: Params$Resource$Organizations$Locations$Buckets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Buckets$Views$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Buckets$Views$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$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$Organizations$Locations$Buckets$Views$Get; + {}) as Params$Resource$Organizations$Locations$Buckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Get; + params = {} as Params$Resource$Organizations$Locations$Buckets$Get; options = {}; } @@ -17781,68 +17197,70 @@ export namespace logging_v2 { 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 log buckets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Getiampolicy, + list( + params: Params$Resource$Organizations$Locations$Buckets$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, + list( + params?: Params$Resource$Organizations$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Buckets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$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$Organizations$Locations$Buckets$Views$Getiampolicy; + {}) as Params$Resource$Organizations$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy; + params = {} as Params$Resource$Organizations$Locations$Buckets$List; options = {}; } @@ -17855,86 +17273,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v2/{+parent}/buckets').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); } } /** - * Lists views on a log bucket. + * Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Buckets$Views$List, + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Buckets$Views$List, + patch( + params?: Params$Resource$Organizations$Locations$Buckets$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$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$Organizations$Locations$Buckets$Views$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$List; + params = {} as Params$Resource$Organizations$Locations$Buckets$Patch; options = {}; } @@ -17947,83 +17361,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v2/{+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); } } /** - * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. + * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Patch, + undelete( + params: Params$Resource$Organizations$Locations$Buckets$Undelete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Patch, + undelete( + params?: Params$Resource$Organizations$Locations$Buckets$Undelete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, + ): GaxiosPromise; + undelete( + params: Params$Resource$Organizations$Locations$Buckets$Undelete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + undelete( + params: Params$Resource$Organizations$Locations$Buckets$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, - callback: BodyResponseCallback + undelete( + params: Params$Resource$Organizations$Locations$Buckets$Undelete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + undelete(callback: BodyResponseCallback): void; + undelete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Undelete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Views$Patch; + {}) as Params$Resource$Organizations$Locations$Buckets$Undelete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Patch; + params = {} as Params$Resource$Organizations$Locations$Buckets$Undelete; options = {}; } @@ -18036,8 +17446,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v2/{+name}:undelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -18048,68 +17461,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Setiampolicy, + updateAsync( + params: Params$Resource$Organizations$Locations$Buckets$Updateasync, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, + updateAsync( + params?: Params$Resource$Organizations$Locations$Buckets$Updateasync, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, + ): GaxiosPromise; + updateAsync( + params: Params$Resource$Organizations$Locations$Buckets$Updateasync, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateAsync( + params: Params$Resource$Organizations$Locations$Buckets$Updateasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, - callback: BodyResponseCallback + updateAsync( + params: Params$Resource$Organizations$Locations$Buckets$Updateasync, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + updateAsync(callback: BodyResponseCallback): void; + updateAsync( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Updateasync + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy; + {}) as Params$Resource$Organizations$Locations$Buckets$Updateasync; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy; + {} as Params$Resource$Organizations$Locations$Buckets$Updateasync; options = {}; } @@ -18122,7 +17535,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v2/{+name}:updateAsync').replace( /([^:]\/)\/+/g, '$1' ), @@ -18132,163 +17545,71 @@ export namespace logging_v2 { 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$Organizations$Locations$Buckets$Create + 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. + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ - testIamPermissions( - params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + bucketId?: string; + /** + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; - const rootUrl = options.rootUrl || 'https://logging.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); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; } - - export interface Params$Resource$Organizations$Locations$Buckets$Views$Create + export interface Params$Resource$Organizations$Locations$Buckets$Createasync extends StandardParameters { /** - * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. */ - parent?: string; + bucketId?: string; /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" */ - viewId?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$LogView; + requestBody?: Schema$LogBucket; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$Delete + export interface Params$Resource$Organizations$Locations$Buckets$Delete extends StandardParameters { /** - * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" */ name?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$Get + export interface Params$Resource$Organizations$Locations$Buckets$Get extends StandardParameters { /** - * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" */ name?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Buckets$Views$List + export interface Params$Resource$Organizations$Locations$Buckets$List extends StandardParameters { /** - * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** @@ -18296,110 +17617,114 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. */ parent?: string; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$Patch + export interface Params$Resource$Organizations$Locations$Buckets$Patch extends StandardParameters { /** - * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" */ name?: string; /** - * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogView; + requestBody?: Schema$LogBucket; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy + export interface Params$Resource$Organizations$Locations$Buckets$Undelete 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. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" */ - resource?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$SetIamPolicyRequest; + requestBody?: Schema$UndeleteBucketRequest; } - export interface Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions + export interface Params$Resource$Organizations$Locations$Buckets$Updateasync 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. + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" */ - resource?: string; + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$LogBucket; } - export class Resource$Organizations$Locations$Buckets$Views$Logs { + export class Resource$Organizations$Locations$Buckets$Links { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + create( + params: Params$Resource$Organizations$Locations$Buckets$Links$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + create( + params?: Params$Resource$Organizations$Locations$Buckets$Links$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Buckets$Links$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Links$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Links$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Buckets$Views$Logs$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Links$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$Organizations$Locations$Buckets$Views$Logs$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Links$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Buckets$Views$Logs$List; + {} as Params$Resource$Organizations$Locations$Buckets$Links$Create; options = {}; } @@ -18412,8 +17737,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+parent}/links').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -18424,95 +17752,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Organizations$Locations$Buckets$Views$Logs$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] - */ - parent?: string; - /** - * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. - */ - resourceNames?: string[]; - } - - 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. + * Deletes a link. This will also delete the corresponding BigQuery linked 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. */ - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, + delete( + params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Organizations$Locations$Operations$Cancel, + delete( + params?: Params$Resource$Organizations$Locations$Buckets$Links$Delete, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Organizations$Locations$Operations$Cancel, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, 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 + delete( + params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + delete( + params: Params$Resource$Organizations$Locations$Buckets$Links$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Links$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$Organizations$Locations$Operations$Cancel; + {}) as Params$Resource$Organizations$Locations$Buckets$Links$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Operations$Cancel; + {} as Params$Resource$Organizations$Locations$Buckets$Links$Delete; options = {}; } @@ -18525,8 +17826,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -18537,17 +17838,17 @@ export namespace logging_v2 { 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 link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18555,49 +17856,50 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizations$Locations$Operations$Get, + params: Params$Resource$Organizations$Locations$Buckets$Links$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Organizations$Locations$Operations$Get, + params?: Params$Resource$Organizations$Locations$Buckets$Links$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Organizations$Locations$Operations$Get, + params: Params$Resource$Organizations$Locations$Buckets$Links$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Links$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Locations$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Links$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Links$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$Organizations$Locations$Operations$Get; + {}) as Params$Resource$Organizations$Locations$Buckets$Links$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Operations$Get; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Links$Get; options = {}; } @@ -18622,17 +17924,17 @@ export namespace logging_v2 { 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 links. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18640,54 +17942,53 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Locations$Operations$List, + params: Params$Resource$Organizations$Locations$Buckets$Links$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Locations$Operations$List, + params?: Params$Resource$Organizations$Locations$Buckets$Links$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Locations$Operations$List, + params: Params$Resource$Organizations$Locations$Buckets$Links$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Links$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Links$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Links$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Operations$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Links$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Operations$List; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Links$List; options = {}; } @@ -18700,7 +18001,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/operations').replace( + url: (rootUrl + '/v2/{+parent}/links').replace( /([^:]\/)\/+/g, '$1' ), @@ -18710,126 +18011,130 @@ export namespace logging_v2 { 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$Organizations$Locations$Operations$Cancel + export interface Params$Resource$Organizations$Locations$Buckets$Links$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. */ - name?: string; + 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]" + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$Link; } - export interface Params$Resource$Organizations$Locations$Operations$Get + export interface Params$Resource$Organizations$Locations$Buckets$Links$Delete extends StandardParameters { /** - * The name of the operation resource. + * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" */ name?: string; } - export interface Params$Resource$Organizations$Locations$Operations$List + export interface Params$Resource$Organizations$Locations$Buckets$Links$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" */ name?: string; + } + export interface Params$Resource$Organizations$Locations$Buckets$Links$List + extends StandardParameters { /** - * The standard list page size. + * Optional. The maximum number of results to return from this request. */ pageSize?: number; /** - * The standard list page token. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. */ pageToken?: string; + /** + * Required. The parent resource whose links are to be listed: "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]" + */ + parent?: string; } - export class Resource$Organizations$Locations$Recentqueries { + export class Resource$Organizations$Locations$Buckets$Views { context: APIRequestContext; + logs: Resource$Organizations$Locations$Buckets$Views$Logs; constructor(context: APIRequestContext) { this.context = context; + this.logs = new Resource$Organizations$Locations$Buckets$Views$Logs( + this.context + ); } /** - * Lists the RecentQueries that were created by the user making the request. + * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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$Recentqueries$List, + create( + params: Params$Resource$Organizations$Locations$Buckets$Views$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Recentqueries$List, + create( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Recentqueries$List, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Buckets$Views$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Locations$Recentqueries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Recentqueries$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Views$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Buckets$Views$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Recentqueries$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Recentqueries$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Recentqueries$List; + {} as Params$Resource$Organizations$Locations$Buckets$Views$Create; options = {}; } @@ -18842,11 +18147,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/recentQueries').replace( + url: (rootUrl + '/v2/{+parent}/views').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -18857,95 +18162,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Organizations$Locations$Recentqueries$List - extends StandardParameters { - /** - * Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") - */ - filter?: string; - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my-project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. + * Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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; - } - - export class Resource$Organizations$Locations$Savedqueries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new SavedQuery for the user making 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. - */ - create( - params: Params$Resource$Organizations$Locations$Savedqueries$Create, + delete( + params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Savedqueries$Create, + delete( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Savedqueries$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Savedqueries$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Savedqueries$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Buckets$Views$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Savedqueries$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Savedqueries$Create; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Savedqueries$Create; + {} as Params$Resource$Organizations$Locations$Buckets$Views$Delete; options = {}; } @@ -18958,83 +18236,80 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/savedQueries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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 an existing SavedQuery that was created by the user making the request. + * Gets a view on a log 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. */ - delete( - params: Params$Resource$Organizations$Locations$Savedqueries$Delete, + get( + params: Params$Resource$Organizations$Locations$Buckets$Views$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Savedqueries$Delete, + get( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Savedqueries$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Buckets$Views$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Savedqueries$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Buckets$Views$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Locations$Savedqueries$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Buckets$Views$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Savedqueries$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Savedqueries$Delete; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Savedqueries$Delete; + {} as Params$Resource$Organizations$Locations$Buckets$Views$Get; options = {}; } @@ -19048,7 +18323,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -19059,67 +18334,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns all data associated with the requested query. + * 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$Organizations$Locations$Savedqueries$Get, + getIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Organizations$Locations$Savedqueries$Get, + getIamPolicy( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Locations$Savedqueries$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Savedqueries$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Organizations$Locations$Savedqueries$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Savedqueries$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Savedqueries$Get; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Savedqueries$Get; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Views$Getiampolicy; options = {}; } @@ -19132,29 +18408,32 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+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 the SavedQueries that were created by the user making the request. + * Lists views on a log bucket. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19162,55 +18441,53 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Locations$Savedqueries$List, + params: Params$Resource$Organizations$Locations$Buckets$Views$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Locations$Savedqueries$List, + params?: Params$Resource$Organizations$Locations$Buckets$Views$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Locations$Savedqueries$List, + params: Params$Resource$Organizations$Locations$Buckets$Views$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Savedqueries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Views$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Locations$Savedqueries$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Views$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Savedqueries$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Savedqueries$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Savedqueries$List; + {} as Params$Resource$Organizations$Locations$Buckets$Views$List; options = {}; } @@ -19223,7 +18500,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/savedQueries').replace( + url: (rootUrl + '/v2/{+parent}/views').replace( /([^:]\/)\/+/g, '$1' ), @@ -19238,17 +18515,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates an existing SavedQuery. + * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19256,50 +18533,50 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Organizations$Locations$Savedqueries$Patch, + params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Organizations$Locations$Savedqueries$Patch, + params?: Params$Resource$Organizations$Locations$Buckets$Views$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Organizations$Locations$Savedqueries$Patch, + params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Organizations$Locations$Savedqueries$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Organizations$Locations$Savedqueries$Patch, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$Views$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Savedqueries$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Savedqueries$Patch; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Organizations$Locations$Savedqueries$Patch; + {} as Params$Resource$Organizations$Locations$Buckets$Views$Patch; options = {}; } @@ -19324,140 +18601,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Organizations$Locations$Savedqueries$Create - extends StandardParameters { - /** - * Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global" "organizations/123456789/locations/us-central1" - */ - parent?: string; - /** - * Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. - */ - savedQueryId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SavedQuery; - } - export interface Params$Resource$Organizations$Locations$Savedqueries$Delete - extends StandardParameters { - /** - * Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Savedqueries$Get - extends StandardParameters { - /** - * Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" - */ - name?: string; - } - export interface Params$Resource$Organizations$Locations$Savedqueries$List - extends StandardParameters { - /** - * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED - */ - filter?: string; - /** - * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" - */ - parent?: string; - } - export interface Params$Resource$Organizations$Locations$Savedqueries$Patch - extends StandardParameters { - /** - * Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket-regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. - */ - name?: string; - /** - * Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SavedQuery; - } - - export class Resource$Organizations$Logs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Organizations$Logs$Delete, + setIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Logs$Delete, + setIamPolicy( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Logs$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Logs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Logs$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Organizations$Logs$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Logs$Delete; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$Delete; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Views$Setiampolicy; options = {}; } @@ -19470,79 +18675,90 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Organizations$Logs$List, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Logs$List, + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Logs$List, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Organizations$Logs$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Organizations$Logs$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Logs$List; + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$List; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Views$Testiampermissions; options = {}; } @@ -19555,63 +18771,250 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Organizations$Logs$Delete - extends StandardParameters { - /** - * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. - */ - logName?: string; - } - export interface Params$Resource$Organizations$Logs$List + export interface Params$Resource$Organizations$Locations$Buckets$Views$Create extends StandardParameters { /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" */ - pageSize?: number; + parent?: string; /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. */ - pageToken?: string; + viewId?: string; + /** - * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + * Request body metadata */ - parent?: string; + requestBody?: Schema$LogView; + } + export interface Params$Resource$Organizations$Locations$Buckets$Views$Delete + extends StandardParameters { /** - * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" */ - resourceNames?: string[]; + name?: string; } + export interface Params$Resource$Organizations$Locations$Buckets$Views$Get + extends StandardParameters { + /** + * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Buckets$Views$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; - export class Resource$Organizations$Sinks { + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Organizations$Locations$Buckets$Views$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Buckets$Views$Patch + extends StandardParameters { + /** + * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + */ + name?: string; + /** + * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogView; + } + export interface Params$Resource$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Buckets$Views$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$Organizations$Locations$Buckets$Views$Logs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. + * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are 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$Organizations$Locations$Buckets$Views$Logs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Buckets$Views$Logs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Buckets$Views$Logs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Buckets$Views$Logs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Organizations$Locations$Buckets$Views$Logs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logs').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$Buckets$Views$Logs$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + */ + parent?: string; + /** + * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + */ + resourceNames?: string[]; + } + + export class Resource$Organizations$Locations$Logscopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19619,49 +19022,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Organizations$Sinks$Create, + params: Params$Resource$Organizations$Locations$Logscopes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Organizations$Sinks$Create, + params?: Params$Resource$Organizations$Locations$Logscopes$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Organizations$Sinks$Create, + params: Params$Resource$Organizations$Locations$Logscopes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Organizations$Sinks$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Organizations$Sinks$Create, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Organizations$Sinks$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Logscopes$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$Organizations$Sinks$Create; + {}) as Params$Resource$Organizations$Locations$Logscopes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$Create; + params = {} as Params$Resource$Organizations$Locations$Logscopes$Create; options = {}; } @@ -19674,7 +19077,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/sinks').replace( + url: (rootUrl + '/v2/{+parent}/logScopes').replace( /([^:]\/)\/+/g, '$1' ), @@ -19689,17 +19092,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. + * Deletes a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19707,31 +19110,31 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Organizations$Sinks$Delete, + params: Params$Resource$Organizations$Locations$Logscopes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Organizations$Sinks$Delete, + params?: Params$Resource$Organizations$Locations$Logscopes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Organizations$Sinks$Delete, + params: Params$Resource$Organizations$Locations$Logscopes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Sinks$Delete, + params: Params$Resource$Organizations$Locations$Logscopes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Organizations$Sinks$Delete, + params: Params$Resource$Organizations$Locations$Logscopes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Organizations$Sinks$Delete + | Params$Resource$Organizations$Locations$Logscopes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19744,12 +19147,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Sinks$Delete; + {}) as Params$Resource$Organizations$Locations$Logscopes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$Delete; + params = {} as Params$Resource$Organizations$Locations$Logscopes$Delete; options = {}; } @@ -19762,15 +19165,15 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -19784,7 +19187,7 @@ export namespace logging_v2 { } /** - * Gets a sink. + * Gets a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19792,49 +19195,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Organizations$Sinks$Get, + params: Params$Resource$Organizations$Locations$Logscopes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Organizations$Sinks$Get, + params?: Params$Resource$Organizations$Locations$Logscopes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Organizations$Sinks$Get, + params: Params$Resource$Organizations$Locations$Logscopes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Sinks$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Organizations$Sinks$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Organizations$Sinks$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Logscopes$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$Organizations$Sinks$Get; + {}) as Params$Resource$Organizations$Locations$Logscopes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$Get; + params = {} as Params$Resource$Organizations$Locations$Logscopes$Get; options = {}; } @@ -19847,29 +19250,29 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists sinks. + * Lists log scopes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19877,52 +19280,54 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Organizations$Sinks$List, + params: Params$Resource$Organizations$Locations$Logscopes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Organizations$Sinks$List, + params?: Params$Resource$Organizations$Locations$Logscopes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Sinks$List, + params: Params$Resource$Organizations$Locations$Logscopes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Sinks$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Sinks$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Sinks$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Logscopes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Sinks$List; + {}) as Params$Resource$Organizations$Locations$Logscopes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$List; + params = {} as Params$Resource$Organizations$Locations$Logscopes$List; options = {}; } @@ -19935,7 +19340,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/sinks').replace( + url: (rootUrl + '/v2/{+parent}/logScopes').replace( /([^:]\/)\/+/g, '$1' ), @@ -19950,17 +19355,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field. + * Updates a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19968,49 +19373,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Organizations$Sinks$Patch, + params: Params$Resource$Organizations$Locations$Logscopes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Organizations$Sinks$Patch, + params?: Params$Resource$Organizations$Locations$Logscopes$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Organizations$Sinks$Patch, + params: Params$Resource$Organizations$Locations$Logscopes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Organizations$Sinks$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Organizations$Sinks$Patch, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Logscopes$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Organizations$Sinks$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Logscopes$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$Organizations$Sinks$Patch; + {}) as Params$Resource$Organizations$Locations$Logscopes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$Patch; + params = {} as Params$Resource$Organizations$Locations$Logscopes$Patch; options = {}; } @@ -20023,155 +19428,62 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity 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. - */ - update( - params: Params$Resource$Organizations$Sinks$Update, - options: StreamMethodOptions - ): GaxiosPromise; - update( - params?: Params$Resource$Organizations$Sinks$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Organizations$Sinks$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Organizations$Sinks$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Organizations$Sinks$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Organizations$Sinks$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Sinks$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Sinks$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['sinkName'], - pathParams: ['sinkName'], + 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$Organizations$Sinks$Create + export interface Params$Resource$Organizations$Locations$Logscopes$Create extends StandardParameters { /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. + * Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. */ - customWriterIdentity?: string; + logScopeId?: string; /** - * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" + * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" */ parent?: string; - /** - * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. - */ - uniqueWriterIdentity?: boolean; /** * Request body metadata */ - requestBody?: Schema$LogSink; + requestBody?: Schema$LogScope; } - export interface Params$Resource$Organizations$Sinks$Delete + export interface Params$Resource$Organizations$Locations$Logscopes$Delete extends StandardParameters { /** - * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ - sinkName?: string; + name?: string; } - export interface Params$Resource$Organizations$Sinks$Get + export interface Params$Resource$Organizations$Locations$Logscopes$Get extends StandardParameters { /** - * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" */ - sinkName?: string; + name?: string; } - export interface Params$Resource$Organizations$Sinks$List + export interface Params$Resource$Organizations$Locations$Logscopes$List extends StandardParameters { /** - * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. - */ - filter?: string; - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** @@ -20179,127 +19491,86 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" */ parent?: string; } - export interface Params$Resource$Organizations$Sinks$Patch - extends StandardParameters { - /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. - */ - customWriterIdentity?: string; - /** - * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" - */ - sinkName?: string; - /** - * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. - */ - uniqueWriterIdentity?: boolean; - /** - * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogSink; - } - export interface Params$Resource$Organizations$Sinks$Update + export interface Params$Resource$Organizations$Locations$Logscopes$Patch extends StandardParameters { /** - * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. - */ - customWriterIdentity?: string; - /** - * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" - */ - sinkName?: string; - /** - * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. + * Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope */ - uniqueWriterIdentity?: boolean; + name?: string; /** - * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + * Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogSink; + requestBody?: Schema$LogScope; } - export class Resource$Projects { + export class Resource$Organizations$Locations$Operations { context: APIRequestContext; - exclusions: Resource$Projects$Exclusions; - locations: Resource$Projects$Locations; - logs: Resource$Projects$Logs; - metrics: Resource$Projects$Metrics; - sinks: Resource$Projects$Sinks; constructor(context: APIRequestContext) { this.context = context; - this.exclusions = new Resource$Projects$Exclusions(this.context); - this.locations = new Resource$Projects$Locations(this.context); - this.logs = new Resource$Projects$Logs(this.context); - this.metrics = new Resource$Projects$Metrics(this.context); - this.sinks = new Resource$Projects$Sinks(this.context); } /** - * Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + * 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. */ - getCmekSettings( - params: Params$Resource$Projects$Getcmeksettings, + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - getCmekSettings( - params?: Params$Resource$Projects$Getcmeksettings, + cancel( + params?: Params$Resource$Organizations$Locations$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - getCmekSettings( - params: Params$Resource$Projects$Getcmeksettings, + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getCmekSettings( - params: Params$Resource$Projects$Getcmeksettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getCmekSettings( - params: Params$Resource$Projects$Getcmeksettings, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Organizations$Locations$Operations$Cancel, + callback: BodyResponseCallback ): void; - getCmekSettings(callback: BodyResponseCallback): void; - getCmekSettings( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Getcmeksettings - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getcmeksettings; + {}) as Params$Resource$Organizations$Locations$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getcmeksettings; + params = + {} as Params$Resource$Organizations$Locations$Operations$Cancel; options = {}; } @@ -20312,11 +19583,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/cmekSettings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -20327,67 +19595,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more information. + * 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. */ - getSettings( - params: Params$Resource$Projects$Getsettings, + get( + params: Params$Resource$Organizations$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - getSettings( - params?: Params$Resource$Projects$Getsettings, + get( + params?: Params$Resource$Organizations$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - getSettings( - params: Params$Resource$Projects$Getsettings, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSettings( - params: Params$Resource$Projects$Getsettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSettings( - params: Params$Resource$Projects$Getsettings, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Operations$Get, + callback: BodyResponseCallback ): void; - getSettings(callback: BodyResponseCallback): void; - getSettings( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Getsettings - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$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$Getsettings; + {}) as Params$Resource$Organizations$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getsettings; + params = {} as Params$Resource$Organizations$Locations$Operations$Get; options = {}; } @@ -20400,10 +19668,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/settings').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -20415,89 +19680,72 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Getcmeksettings - extends StandardParameters { - /** - * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. - */ - name?: string; - } - export interface Params$Resource$Projects$Getsettings - extends StandardParameters { - /** - * Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. - */ - name?: string; - } - - export class Resource$Projects$Exclusions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a 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. */ - create( - params: Params$Resource$Projects$Exclusions$Create, + list( + params: Params$Resource$Organizations$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Exclusions$Create, + list( + params?: Params$Resource$Organizations$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Exclusions$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Exclusions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Exclusions$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Operations$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Create - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Exclusions$Create; + {}) as Params$Resource$Organizations$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Create; + params = {} as Params$Resource$Organizations$Locations$Operations$List; options = {}; } @@ -20510,82 +19758,136 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/exclusions').replace( + url: (rootUrl + '/v2/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Locations$Operations$Cancel + extends StandardParameters { /** - * Deletes an exclusion in the _Default sink. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + 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$Organizations$Locations$Recentqueries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the RecentQueries that were created by the user making 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. */ - delete( - params: Params$Resource$Projects$Exclusions$Delete, + list( + params: Params$Resource$Organizations$Locations$Recentqueries$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Exclusions$Delete, + list( + params?: Params$Resource$Organizations$Locations$Recentqueries$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Exclusions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Recentqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Exclusions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Recentqueries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Exclusions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Recentqueries$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Recentqueries$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$Exclusions$Delete; + {}) as Params$Resource$Organizations$Locations$Recentqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Delete; + params = + {} as Params$Resource$Organizations$Locations$Recentqueries$List; options = {}; } @@ -20598,79 +19900,110 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', + url: (rootUrl + '/v2/{+parent}/recentQueries').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$Organizations$Locations$Recentqueries$List + extends StandardParameters { /** - * Gets the description of an exclusion in the _Default sink. + * Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") + */ + filter?: string; + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my-project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. + */ + parent?: string; + } + + export class Resource$Organizations$Locations$Savedqueries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new SavedQuery for the user making the request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Exclusions$Get, + create( + params: Params$Resource$Organizations$Locations$Savedqueries$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Exclusions$Get, + create( + params?: Params$Resource$Organizations$Locations$Savedqueries$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Exclusions$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Locations$Savedqueries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Exclusions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Savedqueries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Exclusions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Locations$Savedqueries$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Savedqueries$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$Exclusions$Get; + {}) as Params$Resource$Organizations$Locations$Savedqueries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Get; + params = + {} as Params$Resource$Organizations$Locations$Savedqueries$Create; options = {}; } @@ -20683,84 +20016,83 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+parent}/savedQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists all the exclusions on the _Default sink in a parent resource. + * Deletes an existing SavedQuery that was created by the user making 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$Exclusions$List, + delete( + params: Params$Resource$Organizations$Locations$Savedqueries$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Exclusions$List, + delete( + params?: Params$Resource$Organizations$Locations$Savedqueries$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Exclusions$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Savedqueries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Exclusions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Savedqueries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Exclusions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Savedqueries$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Savedqueries$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$Exclusions$List; + {}) as Params$Resource$Organizations$Locations$Savedqueries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$List; + params = + {} as Params$Resource$Organizations$Locations$Savedqueries$Delete; options = {}; } @@ -20773,82 +20105,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/exclusions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v2/{+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); } } /** - * Changes one or more properties of an existing exclusion in the _Default sink. + * Returns all data associated with the requested query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Exclusions$Patch, + get( + params: Params$Resource$Organizations$Locations$Savedqueries$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Exclusions$Patch, + get( + params?: Params$Resource$Organizations$Locations$Savedqueries$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Exclusions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Savedqueries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Exclusions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Savedqueries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Exclusions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Savedqueries$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Savedqueries$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$Exclusions$Patch; + {}) as Params$Resource$Organizations$Locations$Savedqueries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Patch; + params = {} as Params$Resource$Organizations$Locations$Savedqueries$Get; options = {}; } @@ -20862,7 +20191,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20873,146 +20202,73 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Exclusions$Create - extends StandardParameters { - /** - * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$LogExclusion; - } - export interface Params$Resource$Projects$Exclusions$Delete - extends StandardParameters { - /** - * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" + * Lists the SavedQueries that were created by the user making 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. */ - name?: string; - } - export interface Params$Resource$Projects$Exclusions$Get - extends StandardParameters { - /** - * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" - */ - name?: string; - } - export interface Params$Resource$Projects$Exclusions$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" - */ - parent?: string; - } - export interface Params$Resource$Projects$Exclusions$Patch - extends StandardParameters { - /** - * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" - */ - name?: string; - /** - * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogExclusion; - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - buckets: Resource$Projects$Locations$Buckets; - operations: Resource$Projects$Locations$Operations; - recentQueries: Resource$Projects$Locations$Recentqueries; - savedQueries: Resource$Projects$Locations$Savedqueries; - constructor(context: APIRequestContext) { - this.context = context; - this.buckets = new Resource$Projects$Locations$Buckets(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.recentQueries = new Resource$Projects$Locations$Recentqueries( - this.context - ); - this.savedQueries = new Resource$Projects$Locations$Savedqueries( - 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, + list( + params: Params$Resource$Organizations$Locations$Savedqueries$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, + list( + params?: Params$Resource$Organizations$Locations$Savedqueries$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Savedqueries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Savedqueries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Locations$Savedqueries$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Savedqueries$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$Get; + {}) as Params$Resource$Organizations$Locations$Savedqueries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Organizations$Locations$Savedqueries$List; options = {}; } @@ -21025,84 +20281,83 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/savedQueries').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 information about the supported locations for this service. + * Updates an existing SavedQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional 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, + patch( + params: Params$Resource$Organizations$Locations$Savedqueries$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, + patch( + params?: Params$Resource$Organizations$Locations$Savedqueries$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Savedqueries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Savedqueries$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Locations$Savedqueries$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Savedqueries$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$List; + {}) as Params$Resource$Organizations$Locations$Savedqueries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Organizations$Locations$Savedqueries$Patch; options = {}; } @@ -21115,11 +20370,8 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -21130,105 +20382,140 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Get + export interface Params$Resource$Organizations$Locations$Savedqueries$Create extends StandardParameters { /** - * Resource name for the location. + * Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global" "organizations/123456789/locations/us-central1" */ - name?: string; + parent?: string; + /** + * Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, periods.First character has to be alphanumeric. + */ + savedQueryId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SavedQuery; } - export interface Params$Resource$Projects$Locations$List + export interface Params$Resource$Organizations$Locations$Savedqueries$Delete extends StandardParameters { /** - * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). + * Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" */ - filter?: string; + name?: string; + } + export interface Params$Resource$Organizations$Locations$Savedqueries$Get + extends StandardParameters { /** - * The resource that owns the locations collection, if applicable. + * Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my-saved-query" */ name?: string; + } + export interface Params$Resource$Organizations$Locations$Savedqueries$List + extends StandardParameters { /** - * The maximum number of results to return. If not set, the service selects a default. + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; + /** + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** - * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. */ pageToken?: string; + /** + * Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Savedqueries$Patch + extends StandardParameters { + /** + * Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket-regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. + */ + name?: string; + /** + * Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SavedQuery; } - export class Resource$Projects$Locations$Buckets { + export class Resource$Organizations$Logs { context: APIRequestContext; - links: Resource$Projects$Locations$Buckets$Links; - views: Resource$Projects$Locations$Buckets$Views; constructor(context: APIRequestContext) { this.context = context; - this.links = new Resource$Projects$Locations$Buckets$Links(this.context); - this.views = new Resource$Projects$Locations$Buckets$Views(this.context); } /** - * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. + * Deletes all the log entries in a log for the _Default Log Bucket. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Buckets$Create, + delete( + params: Params$Resource$Organizations$Logs$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Buckets$Create, + delete( + params?: Params$Resource$Organizations$Logs$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Buckets$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Logs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Buckets$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Buckets$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Logs$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Create - | BodyResponseCallback + | Params$Resource$Organizations$Logs$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$Buckets$Create; + {}) as Params$Resource$Organizations$Logs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Create; + params = {} as Params$Resource$Organizations$Logs$Delete; options = {}; } @@ -21241,11 +20528,93 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['logName'], + pathParams: ['logName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are 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$Organizations$Logs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Logs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Logs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Logs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Logs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Logs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Logs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -21256,67 +20625,101 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Logs$Delete + extends StandardParameters { /** - * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. + * Required. The resource name of the log to delete: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example, "projects/my-project-id/logs/syslog", "organizations/123/logs/cloudaudit.googleapis.com%2Factivity".For more information about log names, see LogEntry. + */ + logName?: string; + } + export interface Params$Resource$Organizations$Logs$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + */ + parent?: string; + /** + * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + */ + resourceNames?: string[]; + } + + export class Resource$Organizations$Sinks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a sink that exports specified log entries to a destination. The export begins upon ingress, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - createAsync( - params: Params$Resource$Projects$Locations$Buckets$Createasync, + create( + params: Params$Resource$Organizations$Sinks$Create, options: StreamMethodOptions ): GaxiosPromise; - createAsync( - params?: Params$Resource$Projects$Locations$Buckets$Createasync, + create( + params?: Params$Resource$Organizations$Sinks$Create, options?: MethodOptions - ): GaxiosPromise; - createAsync( - params: Params$Resource$Projects$Locations$Buckets$Createasync, + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Sinks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Projects$Locations$Buckets$Createasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Sinks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - createAsync( - params: Params$Resource$Projects$Locations$Buckets$Createasync, - callback: BodyResponseCallback + create( + params: Params$Resource$Organizations$Sinks$Create, + callback: BodyResponseCallback ): void; - createAsync(callback: BodyResponseCallback): void; - createAsync( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Createasync - | BodyResponseCallback + | Params$Resource$Organizations$Sinks$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$Buckets$Createasync; + {}) as Params$Resource$Organizations$Sinks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Createasync; + params = {} as Params$Resource$Organizations$Sinks$Create; options = {}; } @@ -21329,7 +20732,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets:createAsync').replace( + url: (rootUrl + '/v2/{+parent}/sinks').replace( /([^:]\/)\/+/g, '$1' ), @@ -21344,17 +20747,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. + * Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21362,31 +20765,31 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Buckets$Delete, + params: Params$Resource$Organizations$Sinks$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Buckets$Delete, + params?: Params$Resource$Organizations$Sinks$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Buckets$Delete, + params: Params$Resource$Organizations$Sinks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Buckets$Delete, + params: Params$Resource$Organizations$Sinks$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Buckets$Delete, + params: Params$Resource$Organizations$Sinks$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Delete + | Params$Resource$Organizations$Sinks$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21399,12 +20802,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Buckets$Delete; + {}) as Params$Resource$Organizations$Sinks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Delete; + params = {} as Params$Resource$Organizations$Sinks$Delete; options = {}; } @@ -21417,15 +20820,15 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { @@ -21439,7 +20842,7 @@ export namespace logging_v2 { } /** - * Gets a log bucket. + * Gets a sink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21447,49 +20850,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Buckets$Get, + params: Params$Resource$Organizations$Sinks$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Buckets$Get, + params?: Params$Resource$Organizations$Sinks$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Buckets$Get, + params: Params$Resource$Organizations$Sinks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Buckets$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Buckets$Get, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Get - | BodyResponseCallback + | Params$Resource$Organizations$Sinks$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$Buckets$Get; + {}) as Params$Resource$Organizations$Sinks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Get; + params = {} as Params$Resource$Organizations$Sinks$Get; options = {}; } @@ -21502,29 +20905,29 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists log buckets. + * Lists sinks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21532,52 +20935,52 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Buckets$List, + params: Params$Resource$Organizations$Sinks$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Buckets$List, + params?: Params$Resource$Organizations$Sinks$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Buckets$List, + params: Params$Resource$Organizations$Sinks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Buckets$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Buckets$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$List - | BodyResponseCallback + | Params$Resource$Organizations$Sinks$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$Buckets$List; + {}) as Params$Resource$Organizations$Sinks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$List; + params = {} as Params$Resource$Organizations$Sinks$List; options = {}; } @@ -21590,7 +20993,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/buckets').replace( + url: (rootUrl + '/v2/{+parent}/sinks').replace( /([^:]\/)\/+/g, '$1' ), @@ -21605,17 +21008,17 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity field. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21623,49 +21026,49 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Buckets$Patch, + params: Params$Resource$Organizations$Sinks$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Buckets$Patch, + params?: Params$Resource$Organizations$Sinks$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Buckets$Patch, + params: Params$Resource$Organizations$Sinks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Buckets$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Buckets$Patch, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Sinks$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Patch - | BodyResponseCallback + | Params$Resource$Organizations$Sinks$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$Buckets$Patch; + {}) as Params$Resource$Organizations$Sinks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Patch; + params = {} as Params$Resource$Organizations$Sinks$Patch; options = {}; } @@ -21678,79 +21081,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. + * Updates a sink. This method replaces the values of the destination and filter fields of the existing sink with the corresponding values from the new sink.The updated sink might also have a new writer_identity; see the unique_writer_identity 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. */ - undelete( - params: Params$Resource$Projects$Locations$Buckets$Undelete, + update( + params: Params$Resource$Organizations$Sinks$Update, options: StreamMethodOptions ): GaxiosPromise; - undelete( - params?: Params$Resource$Projects$Locations$Buckets$Undelete, + update( + params?: Params$Resource$Organizations$Sinks$Update, options?: MethodOptions - ): GaxiosPromise; - undelete( - params: Params$Resource$Projects$Locations$Buckets$Undelete, + ): GaxiosPromise; + update( + params: Params$Resource$Organizations$Sinks$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Projects$Locations$Buckets$Undelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + update( + params: Params$Resource$Organizations$Sinks$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - undelete( - params: Params$Resource$Projects$Locations$Buckets$Undelete, - callback: BodyResponseCallback + update( + params: Params$Resource$Organizations$Sinks$Update, + callback: BodyResponseCallback ): void; - undelete(callback: BodyResponseCallback): void; - undelete( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Undelete - | BodyResponseCallback + | Params$Resource$Organizations$Sinks$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Buckets$Undelete; + {}) as Params$Resource$Organizations$Sinks$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Undelete; + params = {} as Params$Resource$Organizations$Sinks$Update; options = {}; } @@ -21763,82 +21166,2201 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:undelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+sinkName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['sinkName'], + pathParams: ['sinkName'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Organizations$Sinks$Create + extends StandardParameters { /** - * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. */ - updateAsync( - params: Params$Resource$Projects$Locations$Buckets$Updateasync, - options: StreamMethodOptions - ): GaxiosPromise; - updateAsync( - params?: Params$Resource$Projects$Locations$Buckets$Updateasync, - options?: MethodOptions - ): GaxiosPromise; - updateAsync( - params: Params$Resource$Projects$Locations$Buckets$Updateasync, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAsync( - params: Params$Resource$Projects$Locations$Buckets$Updateasync, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateAsync( - params: Params$Resource$Projects$Locations$Buckets$Updateasync, - callback: BodyResponseCallback - ): void; - updateAsync(callback: BodyResponseCallback): void; - updateAsync( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Updateasync - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Buckets$Updateasync; - let options = (optionsOrCallback || {}) as MethodOptions; + customWriterIdentity?: string; + /** + * Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" + */ + parent?: string; + /** + * Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. + */ + uniqueWriterIdentity?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$LogSink; + } + export interface Params$Resource$Organizations$Sinks$Delete + extends StandardParameters { + /** + * Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + */ + sinkName?: string; + } + export interface Params$Resource$Organizations$Sinks$Get + extends StandardParameters { + /** + * Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + */ + sinkName?: string; + } + export interface Params$Resource$Organizations$Sinks$List + extends StandardParameters { + /** + * Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. + */ + filter?: string; + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + */ + parent?: string; + } + export interface Params$Resource$Organizations$Sinks$Patch + extends StandardParameters { + /** + * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. + */ + customWriterIdentity?: string; + /** + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + */ + sinkName?: string; + /** + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. + */ + uniqueWriterIdentity?: boolean; + /** + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogSink; + } + export interface Params$Resource$Organizations$Sinks$Update + extends StandardParameters { + /** + * Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. + */ + customWriterIdentity?: string; + /** + * Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my-project/sinks/my-sink" + */ + sinkName?: string; + /** + * Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. + */ + uniqueWriterIdentity?: boolean; + /** + * Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogSink; + } + + export class Resource$Projects { + context: APIRequestContext; + exclusions: Resource$Projects$Exclusions; + locations: Resource$Projects$Locations; + logs: Resource$Projects$Logs; + metrics: Resource$Projects$Metrics; + sinks: Resource$Projects$Sinks; + constructor(context: APIRequestContext) { + this.context = context; + this.exclusions = new Resource$Projects$Exclusions(this.context); + this.locations = new Resource$Projects$Locations(this.context); + this.logs = new Resource$Projects$Logs(this.context); + this.metrics = new Resource$Projects$Metrics(this.context); + this.sinks = new Resource$Projects$Sinks(this.context); + } + + /** + * Gets the Logging CMEK settings for the given resource.Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getCmekSettings( + params: Params$Resource$Projects$Getcmeksettings, + options: StreamMethodOptions + ): GaxiosPromise; + getCmekSettings( + params?: Params$Resource$Projects$Getcmeksettings, + options?: MethodOptions + ): GaxiosPromise; + getCmekSettings( + params: Params$Resource$Projects$Getcmeksettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekSettings( + params: Params$Resource$Projects$Getcmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekSettings( + params: Params$Resource$Projects$Getcmeksettings, + callback: BodyResponseCallback + ): void; + getCmekSettings(callback: BodyResponseCallback): void; + getCmekSettings( + paramsOrCallback?: + | Params$Resource$Projects$Getcmeksettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getcmeksettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getcmeksettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/cmekSettings').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 settings for the given resource.Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts.See View default resource settings for Logging (https://cloud.google.com/logging/docs/default-settings#view-org-settings) for more information. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSettings( + params: Params$Resource$Projects$Getsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getSettings( + params?: Params$Resource$Projects$Getsettings, + options?: MethodOptions + ): GaxiosPromise; + getSettings( + params: Params$Resource$Projects$Getsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSettings( + params: Params$Resource$Projects$Getsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSettings( + params: Params$Resource$Projects$Getsettings, + callback: BodyResponseCallback + ): void; + getSettings(callback: BodyResponseCallback): void; + getSettings( + paramsOrCallback?: + | Params$Resource$Projects$Getsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/settings').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$Getcmeksettings + extends StandardParameters { + /** + * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. + */ + name?: string; + } + export interface Params$Resource$Projects$Getsettings + extends StandardParameters { + /** + * Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. + */ + name?: string; + } + + export class Resource$Projects$Exclusions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Exclusions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Exclusions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Exclusions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Exclusions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Exclusions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/exclusions').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 exclusion in the _Default sink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Exclusions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Exclusions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Exclusions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Exclusions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Exclusions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 description of an exclusion in the _Default sink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Exclusions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Exclusions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Exclusions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Exclusions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Exclusions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 all the exclusions on the _Default sink in a parent 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$Exclusions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Exclusions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Exclusions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Exclusions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Exclusions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/exclusions').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); + } + } + + /** + * Changes one or more properties of an existing exclusion in the _Default sink. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Exclusions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Exclusions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Exclusions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Exclusions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Exclusions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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$Exclusions$Create + extends StandardParameters { + /** + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogExclusion; + } + export interface Params$Resource$Projects$Exclusions$Delete + extends StandardParameters { + /** + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" + */ + name?: string; + } + export interface Params$Resource$Projects$Exclusions$Get + extends StandardParameters { + /** + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" + */ + name?: string; + } + export interface Params$Resource$Projects$Exclusions$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + */ + parent?: string; + } + export interface Params$Resource$Projects$Exclusions$Patch + extends StandardParameters { + /** + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" + */ + name?: string; + /** + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogExclusion; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + buckets: Resource$Projects$Locations$Buckets; + logScopes: Resource$Projects$Locations$Logscopes; + operations: Resource$Projects$Locations$Operations; + recentQueries: Resource$Projects$Locations$Recentqueries; + savedQueries: Resource$Projects$Locations$Savedqueries; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Projects$Locations$Buckets(this.context); + this.logScopes = new Resource$Projects$Locations$Logscopes(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.recentQueries = new Resource$Projects$Locations$Recentqueries( + this.context + ); + this.savedQueries = new Resource$Projects$Locations$Savedqueries( + 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://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Buckets { + context: APIRequestContext; + links: Resource$Projects$Locations$Buckets$Links; + views: Resource$Projects$Locations$Buckets$Views; + constructor(context: APIRequestContext) { + this.context = context; + this.links = new Resource$Projects$Locations$Buckets$Links(this.context); + this.views = new Resource$Projects$Locations$Buckets$Views(this.context); + } + + /** + * Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Buckets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/buckets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + createAsync( + params: Params$Resource$Projects$Locations$Buckets$Createasync, + options: StreamMethodOptions + ): GaxiosPromise; + createAsync( + params?: Params$Resource$Projects$Locations$Buckets$Createasync, + options?: MethodOptions + ): GaxiosPromise; + createAsync( + params: Params$Resource$Projects$Locations$Buckets$Createasync, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createAsync( + params: Params$Resource$Projects$Locations$Buckets$Createasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createAsync( + params: Params$Resource$Projects$Locations$Buckets$Createasync, + callback: BodyResponseCallback + ): void; + createAsync(callback: BodyResponseCallback): void; + createAsync( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Createasync + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Createasync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Createasync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/buckets:createAsync').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 log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently 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$Buckets$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Buckets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Buckets$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 a log 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. + */ + get( + params: Params$Resource$Projects$Locations$Buckets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Buckets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Buckets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Buckets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 log buckets. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Buckets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Buckets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Buckets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Buckets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/buckets').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 log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Buckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Buckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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); + } + } + + /** + * Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Buckets$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Buckets$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Buckets$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Buckets$Undelete, + callback: BodyResponseCallback + ): void; + undelete(callback: BodyResponseCallback): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Undelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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); + } + } + + /** + * Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateAsync( + params: Params$Resource$Projects$Locations$Buckets$Updateasync, + options: StreamMethodOptions + ): GaxiosPromise; + updateAsync( + params?: Params$Resource$Projects$Locations$Buckets$Updateasync, + options?: MethodOptions + ): GaxiosPromise; + updateAsync( + params: Params$Resource$Projects$Locations$Buckets$Updateasync, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAsync( + params: Params$Resource$Projects$Locations$Buckets$Updateasync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAsync( + params: Params$Resource$Projects$Locations$Buckets$Updateasync, + callback: BodyResponseCallback + ): void; + updateAsync(callback: BodyResponseCallback): void; + updateAsync( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Updateasync + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Updateasync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Updateasync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:updateAsync').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$Buckets$Create + extends StandardParameters { + /** + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + */ + bucketId?: string; + /** + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Projects$Locations$Buckets$Createasync + extends StandardParameters { + /** + * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + */ + bucketId?: string; + /** + * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Projects$Locations$Buckets$Delete + extends StandardParameters { + /** + * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$Get + extends StandardParameters { + /** + * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$Patch + extends StandardParameters { + /** + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + export interface Params$Resource$Projects$Locations$Buckets$Undelete + extends StandardParameters { + /** + * Required. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UndeleteBucketRequest; + } + export interface Params$Resource$Projects$Locations$Buckets$Updateasync + extends StandardParameters { + /** + * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + + export class Resource$Projects$Locations$Buckets$Links { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Buckets$Links$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Buckets$Links$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Buckets$Links$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Links$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Buckets$Links$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Links$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Links$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Links$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/links').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 link. This will also delete the corresponding BigQuery linked 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$Projects$Locations$Buckets$Links$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Buckets$Links$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Buckets$Links$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Links$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Links$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Links$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Links$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Links$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 a link. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Buckets$Links$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Buckets$Links$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Buckets$Links$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Buckets$Links$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Buckets$Links$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Links$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Links$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Links$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.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 links. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Buckets$Links$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Buckets$Links$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Buckets$Links$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Buckets$Links$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Buckets$Links$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Links$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Links$List; + let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Updateasync; + params = {} as Params$Resource$Projects$Locations$Buckets$Links$List; options = {}; } @@ -21851,145 +23373,89 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}:updateAsync').replace( + url: (rootUrl + '/v2/{+parent}/links').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$Buckets$Create - extends StandardParameters { - /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. - */ - bucketId?: string; - /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogBucket; - } - export interface Params$Resource$Projects$Locations$Buckets$Createasync + export interface Params$Resource$Projects$Locations$Buckets$Links$Create extends StandardParameters { /** - * Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. Bucket identifiers must start with an alphanumeric character. + * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. */ - bucketId?: string; + linkId?: string; /** - * Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + * 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]" */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$LogBucket; + requestBody?: Schema$Link; } - export interface Params$Resource$Projects$Locations$Buckets$Delete + export interface Params$Resource$Projects$Locations$Buckets$Links$Delete extends StandardParameters { /** - * Required. The full resource name of the bucket to delete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" */ name?: string; } - export interface Params$Resource$Projects$Locations$Buckets$Get + export interface Params$Resource$Projects$Locations$Buckets$Links$Get extends StandardParameters { /** - * Required. The resource name of the bucket: "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" + * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" */ name?: string; } - export interface Params$Resource$Projects$Locations$Buckets$List + export interface Params$Resource$Projects$Locations$Buckets$Links$List extends StandardParameters { /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Optional. The maximum number of results to return from this request. */ pageSize?: number; /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. */ pageToken?: string; /** - * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. + * Required. The parent resource whose links are to be listed: "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]" */ parent?: string; } - export interface Params$Resource$Projects$Locations$Buckets$Patch - extends StandardParameters { - /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - name?: string; - /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogBucket; - } - export interface Params$Resource$Projects$Locations$Buckets$Undelete - extends StandardParameters { - /** - * Required. The full resource name of the bucket to undelete. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$UndeleteBucketRequest; - } - export interface Params$Resource$Projects$Locations$Buckets$Updateasync - extends StandardParameters { - /** - * Required. The full resource name of the bucket to update. "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]" For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - name?: string; - /** - * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogBucket; - } - export class Resource$Projects$Locations$Buckets$Links { + export class Resource$Projects$Locations$Buckets$Views { context: APIRequestContext; + logs: Resource$Projects$Locations$Buckets$Views$Logs; constructor(context: APIRequestContext) { this.context = context; + this.logs = new Resource$Projects$Locations$Buckets$Views$Logs( + this.context + ); } /** - * Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. + * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21997,49 +23463,137 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Buckets$Links$Create, + params: Params$Resource$Projects$Locations$Buckets$Views$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Buckets$Links$Create, + params?: Params$Resource$Projects$Locations$Buckets$Views$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Buckets$Links$Create, + params: Params$Resource$Projects$Locations$Buckets$Views$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Buckets$Links$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Views$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Buckets$Links$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Views$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Links$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Buckets$Views$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Buckets$Views$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/views').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 view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Buckets$Views$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Buckets$Views$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Views$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Buckets$Views$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Links$Create; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Links$Create; + params = {} as Params$Resource$Projects$Locations$Buckets$Views$Delete; options = {}; } @@ -22052,82 +23606,79 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/links').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+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 link. This will also delete the corresponding BigQuery linked dataset. + * Gets a view on a log 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. */ - delete( - params: Params$Resource$Projects$Locations$Buckets$Links$Delete, + get( + params: Params$Resource$Projects$Locations$Buckets$Views$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Buckets$Links$Delete, + get( + params?: Params$Resource$Projects$Locations$Buckets$Views$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Buckets$Links$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Buckets$Views$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Buckets$Links$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Buckets$Views$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Buckets$Links$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Buckets$Views$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Links$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Links$Delete; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Links$Delete; + params = {} as Params$Resource$Projects$Locations$Buckets$Views$Get; options = {}; } @@ -22141,7 +23692,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -22152,67 +23703,68 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a link. + * 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$Buckets$Links$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Buckets$Links$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Buckets$Links$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Buckets$Links$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Buckets$Links$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Links$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Links$Get; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Links$Get; + params = + {} as Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy; options = {}; } @@ -22225,29 +23777,32 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+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 links. + * Lists views on a log bucket. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22255,52 +23810,52 @@ export namespace logging_v2 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Buckets$Links$List, + params: Params$Resource$Projects$Locations$Buckets$Views$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Buckets$Links$List, + params?: Params$Resource$Projects$Locations$Buckets$Views$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Buckets$Links$List, + params: Params$Resource$Projects$Locations$Buckets$Views$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Buckets$Links$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Views$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Buckets$Links$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Views$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Links$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Links$List; + {}) as Params$Resource$Projects$Locations$Buckets$Views$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Links$List; + params = {} as Params$Resource$Projects$Locations$Buckets$Views$List; options = {}; } @@ -22313,7 +23868,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/links').replace( + url: (rootUrl + '/v2/{+parent}/views').replace( /([^:]\/)\/+/g, '$1' ), @@ -22328,106 +23883,49 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Buckets$Links$Create - extends StandardParameters { - /** - * Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it. - */ - 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]" - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Link; - } - export interface Params$Resource$Projects$Locations$Buckets$Links$Delete - extends StandardParameters { - /** - * Required. The full resource name of the link to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Buckets$Links$Get - extends StandardParameters { - /** - * Required. The resource name of the link: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Buckets$Links$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. - */ - pageToken?: string; - /** - * Required. The parent resource whose links are to be listed: "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]" - */ - parent?: string; - } - - export class Resource$Projects$Locations$Buckets$Views { - context: APIRequestContext; - logs: Resource$Projects$Locations$Buckets$Views$Logs; - constructor(context: APIRequestContext) { - this.context = context; - this.logs = new Resource$Projects$Locations$Buckets$Views$Logs( - this.context - ); - } /** - * Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. + * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Create, + patch( + params: Params$Resource$Projects$Locations$Buckets$Views$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Buckets$Views$Create, + patch( + params?: Params$Resource$Projects$Locations$Buckets$Views$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Buckets$Views$Create, + patch( + params: Params$Resource$Projects$Locations$Buckets$Views$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Buckets$Views$Create, + patch( + params: Params$Resource$Projects$Locations$Buckets$Views$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Buckets$Views$Create, + patch( + params: Params$Resource$Projects$Locations$Buckets$Views$Patch, callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Create + | Params$Resource$Projects$Locations$Buckets$Views$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22440,12 +23938,12 @@ export namespace logging_v2 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Buckets$Views$Create; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Views$Create; + params = {} as Params$Resource$Projects$Locations$Buckets$Views$Patch; options = {}; } @@ -22458,18 +23956,15 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -22483,57 +23978,58 @@ export namespace logging_v2 { } /** - * Deletes a view on a log bucket. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can delete the view. If this occurs, please try again in a few minutes. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Buckets$Views$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Buckets$Views$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Buckets$Views$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Buckets$Views$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Buckets$Views$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy + | 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$Buckets$Views$Delete; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Views$Delete; + params = + {} as Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy; options = {}; } @@ -22546,165 +24042,284 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a view on a log bucket. + * 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$Buckets$Views$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Buckets$Views$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Buckets$Views$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Buckets$Views$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Buckets$Views$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Buckets$Views$Get; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Views$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Buckets$Views$Create + extends StandardParameters { + /** + * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" + */ + parent?: string; + /** + * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. + */ + viewId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogView; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$Delete + extends StandardParameters { + /** + * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$Get + extends StandardParameters { + /** + * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Views$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$Patch + extends StandardParameters { + /** + * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" + */ + name?: string; + /** + * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogView; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Buckets$Views$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; - const rootUrl = options.rootUrl || 'https://logging.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); - } + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Buckets$Views$Logs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are 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. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Buckets$Views$Logs$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$Buckets$Views$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Buckets$Views$Logs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Buckets$Views$Getiampolicy; + {} as Params$Resource$Projects$Locations$Buckets$Views$Logs$List; options = {}; } @@ -22717,85 +24332,106 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), + 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$Buckets$Views$Logs$List + extends StandardParameters { /** - * Lists views on a log bucket. + * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + */ + pageSize?: number; + /** + * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. + */ + pageToken?: string; + /** + * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + */ + parent?: string; + /** + * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + */ + resourceNames?: string[]; + } + + export class Resource$Projects$Locations$Logscopes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Buckets$Views$List, + create( + params: Params$Resource$Projects$Locations$Logscopes$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Buckets$Views$List, + create( + params?: Params$Resource$Projects$Locations$Logscopes$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Logscopes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Logscopes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Logscopes$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Logscopes$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$Buckets$Views$List; + {}) as Params$Resource$Projects$Locations$Logscopes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Views$List; + params = {} as Params$Resource$Projects$Locations$Logscopes$Create; options = {}; } @@ -22808,11 +24444,11 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/views').replace( + url: (rootUrl + '/v2/{+parent}/logScopes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -22823,67 +24459,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a view on a log bucket. This method replaces the value of the filter field from the existing view with the corresponding value from the new view. If an UNAVAILABLE error is returned, this indicates that system is not in a state where it can update the view. If this occurs, please try again in a few minutes. + * Deletes a log 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$Buckets$Views$Patch, + delete( + params: Params$Resource$Projects$Locations$Logscopes$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Buckets$Views$Patch, + delete( + params?: Params$Resource$Projects$Locations$Logscopes$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Buckets$Views$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Logscopes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Buckets$Views$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Logscopes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Buckets$Views$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Logscopes$Delete, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Logscopes$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$Buckets$Views$Patch; + {}) as Params$Resource$Projects$Locations$Logscopes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Buckets$Views$Patch; + params = {} as Params$Resource$Projects$Locations$Logscopes$Delete; options = {}; } @@ -22897,7 +24533,7 @@ export namespace logging_v2 { options: Object.assign( { url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -22908,68 +24544,67 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Gets a log 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. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Logscopes$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Logscopes$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Logscopes$Get, options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Logscopes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get( + params: Params$Resource$Projects$Locations$Logscopes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Logscopes$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$Buckets$Views$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Logscopes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Buckets$Views$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Logscopes$Get; options = {}; } @@ -22982,90 +24617,84 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:setIamPolicy').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); } } /** - * 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 log scopes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `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$Buckets$Views$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Logscopes$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Logscopes$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Logscopes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Logscopes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Logscopes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Logscopes$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$Buckets$Views$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Logscopes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Buckets$Views$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Logscopes$List; options = {}; } @@ -23078,188 +24707,82 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v2/{+parent}/logScopes').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$Buckets$Views$Create - extends StandardParameters { - /** - * Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" - */ - parent?: string; - /** - * Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. - */ - viewId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogView; - } - export interface Params$Resource$Projects$Locations$Buckets$Views$Delete - extends StandardParameters { - /** - * Required. The full resource name of the view to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Buckets$Views$Get - extends StandardParameters { - /** - * Required. The resource name of the policy: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Views$List - extends StandardParameters { - /** - * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. - */ - pageSize?: number; - /** - * Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. - */ - pageToken?: string; - /** - * Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Buckets$Views$Patch - extends StandardParameters { - /** - * Required. The full resource name of the view to update "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket/views/my-view" - */ - name?: string; - /** - * Optional. Field mask that specifies the fields in view that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogView; - } - export interface Params$Resource$Projects$Locations$Buckets$Views$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$Buckets$Views$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$Buckets$Views$Logs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * Updates a log scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, + patch( + params: Params$Resource$Projects$Locations$Logscopes$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, + patch( + params?: Params$Resource$Projects$Locations$Logscopes$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Logscopes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Logscopes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Buckets$Views$Logs$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Logscopes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Buckets$Views$Logs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Logscopes$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$Buckets$Views$Logs$List; + {}) as Params$Resource$Projects$Locations$Logscopes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Buckets$Views$Logs$List; + params = {} as Params$Resource$Projects$Locations$Logscopes$Patch; options = {}; } @@ -23272,32 +24795,62 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+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$Buckets$Views$Logs$List + export interface Params$Resource$Projects$Locations$Logscopes$Create extends StandardParameters { /** - * Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. + * Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. + */ + logScopeId?: string; + /** + * Required. The parent project in which to create the log scope "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogScope; + } + export interface Params$Resource$Projects$Locations$Logscopes$Delete + extends StandardParameters { + /** + * Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Logscopes$Get + extends StandardParameters { + /** + * Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/logScopes/[LOG_SCOPE_ID]" For example:"projects/my-project/locations/global/logScopes/my-log-scope" + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Logscopes$List + extends StandardParameters { + /** + * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ pageSize?: number; /** @@ -23305,13 +24858,25 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] + * Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Logscopes$Patch + extends StandardParameters { /** - * Optional. List of resource names to list logs for: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. + * Output only. The resource name of the log scope.For example:projects/my-project/locations/global/logScopes/my-log-scope */ - resourceNames?: string[]; + name?: string; + /** + * Optional. Field mask that specifies the fields in log_scope that need an update. A field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=description + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogScope; } export class Resource$Projects$Locations$Operations { diff --git a/src/apis/looker/v1.ts b/src/apis/looker/v1.ts index c0c01fa504..10fdb46d61 100644 --- a/src/apis/looker/v1.ts +++ b/src/apis/looker/v1.ts @@ -375,6 +375,14 @@ export namespace looker_v1 { * Encryption configuration (CMEK). Only set if CMEK has been enabled on the instance. */ encryptionConfig?: Schema$EncryptionConfig; + /** + * Optional. Whether FIPS is enabled on the Looker instance. + */ + fipsEnabled?: boolean | null; + /** + * Optional. Whether Gemini feature is enabled on the Looker instance or not. + */ + geminiEnabled?: boolean | null; /** * Output only. Private Ingress IP (IPv4). */ diff --git a/src/apis/memcache/v1.ts b/src/apis/memcache/v1.ts index aae9d8253e..fa92be2faf 100644 --- a/src/apis/memcache/v1.ts +++ b/src/apis/memcache/v1.ts @@ -137,10 +137,48 @@ export namespace memcache_v1 { */ nodeIds?: string[] | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * Time window specified for daily operations. */ @@ -188,10 +226,22 @@ export namespace memcache_v1 { */ time?: Schema$TimeOfDay; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -571,6 +621,25 @@ export namespace memcache_v1 { */ message?: string | null; } + export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response for ListInstances. */ @@ -639,6 +708,18 @@ export namespace memcache_v1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -826,6 +907,32 @@ export namespace memcache_v1 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } /** * Request for RescheduleMaintenance. */ @@ -856,6 +963,16 @@ export namespace memcache_v1 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -873,6 +990,9 @@ export namespace memcache_v1 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ @@ -950,6 +1070,9 @@ export namespace memcache_v1 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export interface Schema$ZoneMetadata {} export class Resource$Projects { diff --git a/src/apis/memcache/v1beta2.ts b/src/apis/memcache/v1beta2.ts index 31da3d863b..6830cf57e9 100644 --- a/src/apis/memcache/v1beta2.ts +++ b/src/apis/memcache/v1beta2.ts @@ -150,10 +150,48 @@ export namespace memcache_v1beta2 { */ nodeIds?: string[] | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * Time window specified for daily operations. */ @@ -201,10 +239,22 @@ export namespace memcache_v1beta2 { */ time?: Schema$TimeOfDay; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} */ export interface Schema$Empty {} + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -588,6 +638,25 @@ export namespace memcache_v1beta2 { */ message?: string | null; } + export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response for ListInstances. */ @@ -656,6 +725,18 @@ export namespace memcache_v1beta2 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Metadata for the given google.cloud.location.Location. */ @@ -847,6 +928,32 @@ export namespace memcache_v1beta2 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } /** * Request for RescheduleMaintenance. */ @@ -877,6 +984,16 @@ export namespace memcache_v1beta2 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -894,6 +1011,9 @@ export namespace memcache_v1beta2 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ @@ -971,6 +1091,9 @@ export namespace memcache_v1beta2 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export interface Schema$ZoneMetadata {} export class Resource$Projects { diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 01202ed155..539096a458 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -143,19 +143,6 @@ export namespace merchantapi_accounts_v1beta { */ validUntil?: Schema$Date; } - /** - * Reference to a Terms of Service resource. - */ - export interface Schema$AcceptTermsOfService { - /** - * Required. The resource name of the terms of service version. - */ - name?: string | null; - /** - * Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or `001` when it applies globally. - */ - regionCode?: string | null; - } /** * An account. */ @@ -189,6 +176,10 @@ export namespace merchantapi_accounts_v1beta { */ timeZone?: Schema$TimeZone; } + /** + * `AccountAggregation` payload. + */ + export interface Schema$AccountAggregation {} /** * An [`AccountIssue`](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account). */ @@ -223,9 +214,9 @@ export namespace merchantapi_accounts_v1beta { */ export interface Schema$AddAccountService { /** - * The provider is an aggregator for the account. + * The provider is an [aggregator](https://support.google.com/merchants/answer/188487) for the account. Payload for service type Account Aggregation. */ - accountAggregation?: Schema$Empty; + accountAggregation?: Schema$AccountAggregation; /** * Optional. The provider of the service. Format: `accounts/{account\}` */ @@ -256,6 +247,23 @@ export namespace merchantapi_accounts_v1beta { */ streetAddress?: string | null; } + /** + * Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. + */ + export interface Schema$AutofeedSettings { + /** + * Output only. Determines whether merchant is eligible for being enrolled into an autofeed. + */ + eligible?: boolean | null; + /** + * Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear. + */ + enableProducts?: boolean | null; + /** + * Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`. + */ + name?: string | null; + } /** * Business days of the warehouse. */ @@ -364,16 +372,12 @@ export namespace merchantapi_accounts_v1beta { * Request message for the `CreateAndConfigureAccount` method. */ export interface Schema$CreateAndConfigureAccountRequest { - /** - * Optional. The Terms of Service (ToS) to be accepted immediately upon account creation. - */ - acceptTermsOfService?: Schema$AcceptTermsOfService; /** * Required. The account to be created. */ account?: Schema$Account; /** - * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service. + * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently exactly one of these needs to be `account_aggregation`, which means you can only create sub accounts, not standalone account through this method. Additional `account_management` or `product_management` services may be provided. */ service?: Schema$AddAccountService[]; /** @@ -479,7 +483,7 @@ export namespace merchantapi_accounts_v1beta { */ handlingBusinessDayConfig?: Schema$BusinessDayConfig; /** - * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`. + * Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time. */ maxHandlingDays?: number | null; /** @@ -487,7 +491,7 @@ export namespace merchantapi_accounts_v1beta { */ maxTransitDays?: number | null; /** - * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. + * Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. 'min_handling_days' and 'max_handling_days' should be either set or not set at the same time. */ minHandlingDays?: number | null; /** @@ -1509,9 +1513,10 @@ export namespace merchantapi_accounts_v1beta { export class Resource$Accounts { context: APIRequestContext; + autofeedSettings: Resource$Accounts$Autofeedsettings; businessIdentity: Resource$Accounts$Businessidentity; businessInfo: Resource$Accounts$Businessinfo; - emailpreferences: Resource$Accounts$Emailpreferences; + emailPreferences: Resource$Accounts$Emailpreferences; homepage: Resource$Accounts$Homepage; issues: Resource$Accounts$Issues; onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies; @@ -1522,11 +1527,14 @@ export namespace merchantapi_accounts_v1beta { users: Resource$Accounts$Users; constructor(context: APIRequestContext) { this.context = context; + this.autofeedSettings = new Resource$Accounts$Autofeedsettings( + this.context + ); this.businessIdentity = new Resource$Accounts$Businessidentity( this.context ); this.businessInfo = new Resource$Accounts$Businessinfo(this.context); - this.emailpreferences = new Resource$Accounts$Emailpreferences( + this.emailPreferences = new Resource$Accounts$Emailpreferences( this.context ); this.homepage = new Resource$Accounts$Homepage(this.context); @@ -1632,7 +1640,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. + * Deletes the specified account regardless of its type: standalone, MCA or sub-account. Deleting an MCA leads to the deletion of all of its sub-accounts. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1806,7 +1814,7 @@ export namespace merchantapi_accounts_v1beta { } /** - * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. + * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. If no filter is provided, then it returns accounts the user is directly added to. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2087,6 +2095,10 @@ export namespace merchantapi_accounts_v1beta { 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\}` */ @@ -2143,6 +2155,219 @@ export namespace merchantapi_accounts_v1beta { 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. + */ + getAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getAutofeedSettings( + params?: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + options?: MethodOptions + ): GaxiosPromise; + getAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings, + callback: BodyResponseCallback + ): void; + getAutofeedSettings( + callback: BodyResponseCallback + ): void; + getAutofeedSettings( + paramsOrCallback?: + | Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Autofeedsettings$Getautofeedsettings; + 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 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. + */ + updateAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, + options: StreamMethodOptions + ): GaxiosPromise; + updateAutofeedSettings( + params?: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, + options?: MethodOptions + ): GaxiosPromise; + updateAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAutofeedSettings( + params: Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings, + callback: BodyResponseCallback + ): void; + updateAutofeedSettings( + callback: BodyResponseCallback + ): void; + updateAutofeedSettings( + paramsOrCallback?: + | Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings; + 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$Autofeedsettings$Getautofeedsettings + extends StandardParameters { + /** + * Required. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings` + */ + name?: string; + } + export interface Params$Resource$Accounts$Autofeedsettings$Updateautofeedsettings + extends StandardParameters { + /** + * Identifier. The resource name of the autofeed settings. Format: `accounts/{account\}/autofeedSettings`. + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AutofeedSettings; + } + export class Resource$Accounts$Businessidentity { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -3306,13 +3531,9 @@ export namespace merchantapi_accounts_v1beta { */ parent?: string; /** - * IANA Time Zone Database time zone, e.g. "America/New_York". + * Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in human-readable fields. For example 'America/Los_Angeles'. If not set, 'America/Los_Angeles' will be used. */ - 'timeZone.id'?: string; - /** - * Optional. IANA Time Zone Database version number, e.g. "2019a". - */ - 'timeZone.version'?: string; + timeZone?: string; } export class Resource$Accounts$Onlinereturnpolicies { @@ -5685,11 +5906,11 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Termsofservice$Retrievelatest extends StandardParameters { /** - * The Kind this terms of service version applies to. + * Required. The Kind this terms of service version applies to. */ kind?: string; /** - * Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally. + * Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This is either a country when the ToS applies specifically to that country or 001 when it applies globally. */ regionCode?: string; } diff --git a/src/apis/merchantapi/conversions_v1beta.ts b/src/apis/merchantapi/conversions_v1beta.ts index c2aa0362f6..7807c84e87 100644 --- a/src/apis/merchantapi/conversions_v1beta.ts +++ b/src/apis/merchantapi/conversions_v1beta.ts @@ -872,7 +872,7 @@ export namespace merchantapi_conversions_v1beta { 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; } diff --git a/src/apis/merchantapi/datasources_v1beta.ts b/src/apis/merchantapi/datasources_v1beta.ts index cf579e4714..b39c3a94b3 100644 --- a/src/apis/merchantapi/datasources_v1beta.ts +++ b/src/apis/merchantapi/datasources_v1beta.ts @@ -169,6 +169,32 @@ export namespace merchantapi_datasources_v1beta { */ supplementalProductDataSource?: Schema$SupplementalProductDataSource; } + /** + * Data source reference can be used to manage related data sources within the data source service. + */ + export interface Schema$DataSourceReference { + /** + * Optional. The name of the primary data source. Format: `accounts/{account\}/dataSources/{datasource\}` + */ + primaryDataSourceName?: string | null; + /** + * Self should be used to reference the primary data source itself. + */ + self?: boolean | null; + /** + * Optional. The name of the supplemental data source. Format: `accounts/{account\}/dataSources/{datasource\}` + */ + supplementalDataSourceName?: string | null; + } + /** + * Default rule management of the data source. + */ + export interface Schema$DefaultRule { + /** + * Required. The list of data sources linked in the [default rule](https://support.google.com/merchants/answer/7450276). This list is ordered by the default rule priority of joining the data. It might include none or multiple references to `self` and supplemental data sources. The list must not be empty. To link the data source to the default rule, you need to add a new reference to this list (in sequential order). To unlink the data source from the default rule, you need to remove the given reference from this list. Changing the order of this list will result in changing the priority of data sources in the default rule. For example, providing the following list: [`1001`, `self`] will take attribute values from supplemental data source `1001`, and fallback to `self` if the attribute is not set in `1001`. + */ + takeFromDataSources?: Schema$DataSourceReference[]; + } /** * 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); \} */ @@ -235,6 +261,72 @@ export namespace merchantapi_datasources_v1beta { */ fileName?: string | null; } + /** + * The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources. + */ + export interface Schema$FileUpload { + /** + * Output only. The data source id. + */ + dataSourceId?: string | null; + /** + * Output only. The list of issues occurring in the data source. + */ + issues?: Schema$Issue[]; + /** + * Output only. The number of items in the data source that were created. + */ + itemsCreated?: string | null; + /** + * Output only. The number of items in the data source that were processed. + */ + itemsTotal?: string | null; + /** + * Output only. The number of items in the data source that were updated. + */ + itemsUpdated?: string | null; + /** + * Identifier. The name of the data source file upload. Format: `{datasource.name=accounts/{account\}/dataSources/{datasource\}/fileUploads/{fileupload\}\}` + */ + name?: string | null; + /** + * Output only. The processing state of the data source. + */ + processingState?: string | null; + /** + * Output only. The date at which the file of the data source was uploaded. + */ + uploadTime?: string | null; + } + /** + * An error occurring in the data source, like "invalid price". + */ + export interface Schema$Issue { + /** + * Output only. The code of the error, for example, "validation/invalid_value". Returns "?" if the code is unknown. + */ + code?: string | null; + /** + * Output only. The number of occurrences of the error in the file upload. + */ + count?: string | null; + /** + * Output only. The error description, for example, "Your data source contains items which have too many attributes, or are too big. These items will be dropped". + */ + description?: string | null; + /** + * Output only. Link to the documentation explaining the issue in more details, if available. + */ + documentationUri?: string | null; + /** + * Output only. The severity of the issue. + */ + severity?: string | null; + /** + * Output only. The title of the issue, for example, "Item too big". + */ + title?: string | null; + } /** * Response message for the ListDataSources method. */ @@ -277,6 +369,10 @@ export namespace merchantapi_datasources_v1beta { * Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). */ countries?: string[] | null; + /** + * Optional. Default rule management of the data source. If set, the linked data sources will be replaced. + */ + defaultRule?: Schema$DefaultRule; /** * Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. */ @@ -374,6 +470,10 @@ export namespace merchantapi_datasources_v1beta { * Optional. Immutable. The feed label that is specified on the data source level. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-). See also [migration to feed labels](https://developers.google.com/shopping-content/guides/products/feed-labels). `feedLabel` and `contentLanguage` must be either both set or unset for data sources with product content type. They must be set for data sources with a file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept produts without that restriction. */ feedLabel?: string | null; + /** + * Output only. The (unordered and deduplicated) list of all primary data sources linked to this data source in either default or custom rules. Supplemental data source cannot be deleted before all links are removed. + */ + referencingPrimaryDataSources?: Schema$DataSourceReference[]; } /** * 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`. @@ -408,8 +508,12 @@ export namespace merchantapi_datasources_v1beta { export class Resource$Accounts$Datasources { context: APIRequestContext; + fileUploads: Resource$Accounts$Datasources$Fileuploads; constructor(context: APIRequestContext) { this.context = context; + this.fileUploads = new Resource$Accounts$Datasources$Fileuploads( + this.context + ); } /** @@ -1013,4 +1117,107 @@ export namespace merchantapi_datasources_v1beta { */ requestBody?: Schema$DataSource; } + + export class Resource$Accounts$Datasources$Fileuploads { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest data source file upload. Only the `latest` alias is accepted for a file upload. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Datasources$Fileuploads$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Datasources$Fileuploads$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Datasources$Fileuploads$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Datasources$Fileuploads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Datasources$Fileuploads$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Datasources$Fileuploads$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Datasources$Fileuploads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Datasources$Fileuploads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/datasources/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$Datasources$Fileuploads$Get + extends StandardParameters { + /** + * Required. The name of the data source file upload to retrieve. Format: `accounts/{account\}/dataSources/{datasource\}/fileUploads/latest` + */ + name?: string; + } } diff --git a/src/apis/merchantapi/notifications_v1beta.ts b/src/apis/merchantapi/notifications_v1beta.ts index 09366db8e6..39d36d9ad7 100644 --- a/src/apis/merchantapi/notifications_v1beta.ts +++ b/src/apis/merchantapi/notifications_v1beta.ts @@ -238,7 +238,7 @@ export namespace merchantapi_notifications_v1beta { } /** - * Creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self 2. Multiple "partial" subscriptions for managed accounts + subscription for self we will not allow (per merchant as a subscriber per event type): 1. multiple self subscriptions. 2. multiple "all managed accounts" subscriptions. 3. all and partial subscriptions at the same time. 4. multiple partial subscriptions for the same target account + * Creates a notification subscription for a business. For standalone or subaccounts accounts, the business can create a subscription for self. For MCAs, the business can create a subscription for all managed accounts or for a specific subaccount. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/merchantapi/products_v1beta.ts b/src/apis/merchantapi/products_v1beta.ts index 59d25c5040..54b6aa11fc 100644 --- a/src/apis/merchantapi/products_v1beta.ts +++ b/src/apis/merchantapi/products_v1beta.ts @@ -269,9 +269,9 @@ export namespace merchantapi_products_v1beta { */ googleProductCategory?: string | null; /** - * Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. + * Global Trade Item Numbers ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. You can provide up to 10 GTINs. */ - gtin?: string | null; + gtin?: string[] | null; /** * Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided. */ @@ -786,7 +786,7 @@ export namespace merchantapi_products_v1beta { */ feedLabel?: string | null; /** - * The name of the product. Format: `"{product.name=accounts/{account\}/products/{product\}\}"` + * 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" */ name?: string | null; /** @@ -878,7 +878,7 @@ export namespace merchantapi_products_v1beta { */ feedLabel?: string | null; /** - * Identifier. The name of the product input. Format: `"{productinput.name=accounts/{account\}/productInputs/{productinput\}\}"` + * 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" */ name?: string | null; /** @@ -1558,7 +1558,7 @@ export namespace merchantapi_products_v1beta { export interface Params$Resource$Accounts$Products$List extends StandardParameters { /** - * The maximum number of products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of products will be returned. + * The maximum number of products to return. The service may return fewer than this value. The maximum value is 250; values above 250 will be coerced to 250. If unspecified, the maximum number of products will be returned. */ pageSize?: number; /** diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index 0ad43dae22..efa82e6ff9 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -484,11 +484,11 @@ export namespace migrationcenter_v1 { */ export interface Schema$ComputeEngineShapeDescriptor { /** - * Number of logical cores. + * Output only. Number of logical cores. */ logicalCoreCount?: number | null; /** - * Compute Engine machine type. + * Output only. Compute Engine machine type. */ machineType?: string | null; /** @@ -500,11 +500,11 @@ export namespace migrationcenter_v1 { */ physicalCoreCount?: number | null; /** - * Compute Engine machine series. + * Output only. Compute Engine machine series. */ series?: string | null; /** - * Compute Engine storage. Never empty. + * Output only. Compute Engine storage. Never empty. */ storage?: Schema$ComputeStorageDescriptor[]; } @@ -513,11 +513,11 @@ export namespace migrationcenter_v1 { */ export interface Schema$ComputeStorageDescriptor { /** - * Disk size in GiB. + * Output only. Disk size in GiB. */ sizeGb?: number | null; /** - * Disk type backing the storage. + * Output only. Disk type backing the storage. */ type?: string | null; } @@ -863,7 +863,7 @@ export namespace migrationcenter_v1 { */ export interface Schema$FitDescriptor { /** - * Fit level. + * Output only. Fit level. */ fitLevel?: string | null; } @@ -1535,7 +1535,7 @@ export namespace migrationcenter_v1 { */ cpuSocketCount?: number | null; /** - * Number of CPU threads allocated to the machine. + * Deprecated: use MachineDetails.core_count instead. Number of CPU threads allocated to the machine. */ cpuThreadCount?: number | null; /** @@ -2136,7 +2136,7 @@ export namespace migrationcenter_v1 { */ export interface Schema$ReportSummaryAssetAggregateStats { /** - * Histogram showing a distribution of CPU core counts. + * Histogram showing a distribution of logical CPU core counts. */ coreCountHistogram?: Schema$ReportSummaryHistogramChartData; /** diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index e3bfaae01c..696bc5195f 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -316,7 +316,7 @@ export namespace migrationcenter_v1alpha1 { */ name?: string | null; /** - * Output only. Performance data for the asset. + * Performance data for the asset. */ performanceData?: Schema$AssetPerformanceData; /** @@ -407,6 +407,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Resource creation time. */ createTime?: string | null; + /** + * Export asset inventory details. + */ + inventory?: Schema$AssetsExportJobInventory; /** * Optional. Labels as key value pairs. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. */ @@ -419,10 +423,18 @@ export namespace migrationcenter_v1alpha1 { * Export data regarding asset network dependencies. */ networkDependencies?: Schema$AssetsExportJobNetworkDependencies; + /** + * Export asset with performance data. + */ + performanceData?: Schema$AssetsExportJobPerformanceData; /** * Output only. Recent non expired executions of the job. */ recentExecutions?: Schema$AssetsExportJobExecution[]; + /** + * Optional. When this value is set to 'true' the response will include all assets, including those that are hidden. + */ + showHidden?: boolean | null; /** * Export to Cloud Storage files downloadable using signed URIs. */ @@ -448,6 +460,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Expiration time for the export and artifacts. */ expireTime?: string | null; + /** + * Output only. Number of assets requested for export after resolving the requested filters. + */ + requestedAssetCount?: number | null; /** * Output only. Result of the export execution. */ @@ -465,6 +481,10 @@ export namespace migrationcenter_v1alpha1 { * Output only. Error encountered during export. */ error?: Schema$Status; + /** + * Output only. List of output files. + */ + outputFiles?: Schema$OutputFileList; /** * Output only. Signed URLs for downloading export artifacts. */ @@ -479,6 +499,10 @@ export namespace migrationcenter_v1alpha1 { */ filter?: string | null; } + /** + * Configuration for asset inventory details exports. + */ + export interface Schema$AssetsExportJobInventory {} /** * Configuration for network dependencies exports. */ @@ -488,6 +512,15 @@ export namespace migrationcenter_v1alpha1 { */ maxDays?: number | null; } + /** + * Configuration for performance data exports. + */ + export interface Schema$AssetsExportJobPerformanceData { + /** + * Optional. When this value is set to a positive integer, performance data will be returned for the most recent days for which data is available. When this value is unset (or set to zero), all available data is returned. The maximum value is 420; values above 420 will be coerced to 420. If unset (0 value) a default value of 40 will be used. + */ + maxDays?: number | null; + } /** * AWS EC2 specific details. */ @@ -604,7 +637,7 @@ export namespace migrationcenter_v1alpha1 { */ cloudSqlForMysqlShape?: Schema$CloudSqlForMySqlShape; /** - * Cloud SQL for Postgres database shape. + * Cloud SQL for PostgreSQL database shape. */ cloudSqlForPostgresqlShape?: Schema$CloudSqlForPostgreSqlShape; /** @@ -650,7 +683,7 @@ export namespace migrationcenter_v1alpha1 { zoneAvailability?: string | null; } /** - * Cloud SQL for Postgres database shape. + * Cloud SQL for PostgreSQL database shape. */ export interface Schema$CloudSqlForPostgreSqlShape { /** @@ -807,7 +840,7 @@ export namespace migrationcenter_v1alpha1 { */ sizeGb?: number | null; /** - * Disk type backing the storage. + * Output only. Disk type backing the storage. */ type?: string | null; } @@ -820,6 +853,23 @@ export namespace migrationcenter_v1alpha1 { */ utilizedPercentage?: number | null; } + /** + * Contains a single output file of type CSV. + */ + export interface Schema$CsvOutputFile { + /** + * Output only. Number of columns in the file. + */ + columnsCount?: number | null; + /** + * Output only. Number of rows in the file. + */ + rowCount?: number | null; + /** + * Output only. Signed URI destination. + */ + signedUri?: Schema$SignedUri; + } /** * Usage data aggregation for a single day. */ @@ -1116,7 +1166,7 @@ export namespace migrationcenter_v1alpha1 { */ commitmentPlan?: string | null; /** - * Optional. Cloud SQL edition. For SQL Server, only Enterprise is available. + * Optional. Preferred Cloud SQL edition. */ edition?: string | null; /** @@ -1137,7 +1187,7 @@ export namespace migrationcenter_v1alpha1 { */ export interface Schema$DatabasePreferencesCloudSqlCommonBackup { /** - * Optional. Mode of automated backups. + * Optional. Automated backup mode. */ backupMode?: string | null; } @@ -1522,7 +1572,7 @@ export namespace migrationcenter_v1alpha1 { */ export interface Schema$FitDescriptor { /** - * Fit level. + * Output only. Fit level. */ fitLevel?: string | null; } @@ -1667,7 +1717,7 @@ export namespace migrationcenter_v1alpha1 { */ fstab?: Schema$FstabEntryList; /** - * Hosts file (/etc/hosts). + * Output only. Hosts file (/etc/hosts). */ hosts?: Schema$HostsEntryList; /** @@ -1789,7 +1839,7 @@ export namespace migrationcenter_v1alpha1 { */ export interface Schema$HostsEntryList { /** - * Hosts entries. + * Output only. Hosts entries. */ entries?: Schema$HostsEntry[]; } @@ -2723,6 +2773,28 @@ export namespace migrationcenter_v1alpha1 { */ verb?: string | null; } + /** + * Contains a single output file. + */ + export interface Schema$OutputFile { + /** + * Output only. CSV output file. + */ + csvOutputFile?: Schema$CsvOutputFile; + /** + * Output only. File size in bytes. + */ + fileSizeBytes?: number | null; + } + /** + * Contains a list of output files. + */ + export interface Schema$OutputFileList { + /** + * List of output files. + */ + entries?: Schema$OutputFile[]; + } /** * Payload file for inline import job payload. */ @@ -3085,7 +3157,7 @@ export namespace migrationcenter_v1alpha1 { */ assetAge?: Schema$ReportSummaryChartData; /** - * Histogram showing a distribution of CPU core counts. + * Histogram showing a distribution of logical CPU core counts. */ coreCountHistogram?: Schema$ReportSummaryHistogramChartData; /** @@ -3254,7 +3326,7 @@ export namespace migrationcenter_v1alpha1 { */ monthlyCostNetworkEgress?: Schema$Money; /** - * Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines. + * Output only. All operating systems licensing monthly cost for this preference set. Only present for virtual machines. */ monthlyCostOsLicense?: Schema$Money; /** @@ -3909,7 +3981,7 @@ export namespace migrationcenter_v1alpha1 { */ cpuSocketCount?: number | null; /** - * Number of CPU threads allocated to the machine. + * Deprecated: use VirtualMachineDetails.core_count instead. Number of CPU threads allocated to the machine. */ cpuThreadCount?: number | null; /** diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index f273639e43..3d4c4df4e6 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -291,6 +291,15 @@ export namespace monitoring_v3 { */ version?: string[] | null; } + /** + * A test that uses an alerting result in a boolean column produced by the SQL query. + */ + export interface Schema$BooleanTest { + /** + * Required. The name of the column containing the boolean value. If the value in a row is NULL, that row is ignored. + */ + column?: string | null; + } /** * BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \> 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. */ @@ -468,6 +477,10 @@ export namespace monitoring_v3 { * A condition that uses the Prometheus query language to define alerts. */ conditionPrometheusQueryLanguage?: Schema$PrometheusQueryLanguageCondition; + /** + * A condition that uses SQL to define alerts in Logs Analytics. + */ + conditionSql?: Schema$SqlCondition; /** * A condition that compares a time series against a threshold. */ @@ -567,6 +580,19 @@ export namespace monitoring_v3 { * Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. */ export interface Schema$Custom {} + /** + * Used to schedule the query to run every so many days. + */ + export interface Schema$Daily { + /** + * Optional. The time of day (in UTC) at which the query should run. If left unspecified, the server picks an arbitrary time of day and runs the query at the same time each day. + */ + executionTime?: Schema$TimeOfDay; + /** + * Required. LINT.IfChange The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) + */ + periodicity?: number | null; + } /** * Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless. */ @@ -892,6 +918,19 @@ export namespace monitoring_v3 { */ parentName?: string | null; } + /** + * Used to schedule the query to run every so many hours. + */ + export interface Schema$Hourly { + /** + * Optional. LINT.IfChange The number of minutes after the hour (in UTC) to run the query. Must be between 0 and 59 inclusive. If left unspecified, then an arbitrary offset is used. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) + */ + minuteOffset?: number | null; + /** + * Required. LINT.IfChange The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) + */ + periodicity?: number | null; + } /** * Information involved in an HTTP/HTTPS Uptime check request. */ @@ -1407,6 +1446,10 @@ export namespace monitoring_v3 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * A MetricRange is used when each window is good when the value x of a single TimeSeries satisfies range.min <= x <= range.max. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE. @@ -1466,6 +1509,15 @@ export namespace monitoring_v3 { */ trigger?: Schema$Trigger; } + /** + * Used to schedule the query to run every so many minutes. + */ + export interface Schema$Minutes { + /** + * Required. LINT.IfChange Number of minutes between runs. The interval must be between 5 minutes and 1440 minutes. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) + */ + periodicity?: number | null; + } /** * An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" \}\} */ @@ -1767,7 +1819,7 @@ export namespace monitoring_v3 { ruleGroup?: string | null; } /** - * The QueryTimeSeries request. + * The QueryTimeSeries request. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql). */ export interface Schema$QueryTimeSeriesRequest { /** @@ -1784,7 +1836,7 @@ export namespace monitoring_v3 { query?: string | null; } /** - * The QueryTimeSeries response. + * The QueryTimeSeries response. For information about the status of Monitoring Query Language (MQL), see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql). */ export interface Schema$QueryTimeSeriesResponse { /** @@ -1856,6 +1908,19 @@ export namespace monitoring_v3 { */ statusValue?: number | null; } + /** + * A test that checks if the number of rows in the result set violates some threshold. + */ + export interface Schema$RowCountTest { + /** + * Required. The comparison to apply between the number of rows returned by the query and the threshold. + */ + comparison?: string | null; + /** + * Required. The value against which to compare the row count. + */ + threshold?: string | null; + } /** * The SendNotificationChannelVerificationCode request. */ @@ -2023,6 +2088,35 @@ export namespace monitoring_v3 { */ spanName?: string | null; } + /** + * A condition that allows alert policies to be defined using GoogleSQL. SQL conditions examine a sliding window of logs using GoogleSQL. Alert policies with SQL conditions may incur additional billing. + */ + export interface Schema$SqlCondition { + /** + * Test the boolean value in the indicated column. + */ + booleanTest?: Schema$BooleanTest; + /** + * Schedule the query to execute every so many days. + */ + daily?: Schema$Daily; + /** + * Schedule the query to execute every so many hours. + */ + hourly?: Schema$Hourly; + /** + * Schedule the query to execute every so many minutes. + */ + minutes?: Schema$Minutes; + /** + * Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.E.g. Extract all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL + */ + query?: string | null; + /** + * Test the row count against a threshold. + */ + rowCountTest?: Schema$RowCountTest; + } /** * 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). */ @@ -2084,6 +2178,27 @@ export namespace monitoring_v3 { */ startTime?: 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. + */ + export interface Schema$TimeOfDay { + /** + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of hour of day. Must be from 0 to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } /** * A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. */ @@ -6414,7 +6529,7 @@ export namespace monitoring_v3 { } /** - * Queries time series using Monitoring Query Language. + * Queries time series by using Monitoring Query Language (MQL). We recommend using PromQL instead of MQL. For more information about the status of MQL, see the MQL deprecation notice (https://cloud.google.com/stackdriver/docs/deprecations/mql). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/mybusinessbusinessinformation/v1.ts b/src/apis/mybusinessbusinessinformation/v1.ts index 6d0c9bb233..c1366e8a71 100644 --- a/src/apis/mybusinessbusinessinformation/v1.ts +++ b/src/apis/mybusinessbusinessinformation/v1.ts @@ -943,19 +943,19 @@ export namespace mybusinessbusinessinformation_v1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/mybusinesslodging/v1.ts b/src/apis/mybusinesslodging/v1.ts index 3da4298ee0..9eaaa9ef32 100644 --- a/src/apis/mybusinesslodging/v1.ts +++ b/src/apis/mybusinesslodging/v1.ts @@ -2278,19 +2278,19 @@ export namespace mybusinesslodging_v1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 95a91ad014..6effb64d19 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -215,9 +215,13 @@ export namespace networkconnectivity_v1 { */ network?: string | null; /** - * Immutable. An immutable identifier for the producer instance. + * Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. */ producerInstanceId?: string | null; + /** + * Immutable. An immutable map for the producer instance metadata. + */ + producerInstanceMetadata?: {[key: string]: string} | null; /** * The consumer project where PSC connections are allowed to be created in. */ @@ -264,9 +268,13 @@ export namespace networkconnectivity_v1 { */ network?: string | null; /** - * Immutable. An immutable identifier for the producer instance. + * Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. */ producerInstanceId?: string | null; + /** + * Immutable. An immutable map for the producer instance metadata. + */ + producerInstanceMetadata?: {[key: string]: string} | null; /** * The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map. */ @@ -530,13 +538,17 @@ export namespace networkconnectivity_v1 { */ description?: string | null; /** - * The IP range that this internal range defines. + * 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. */ ipCidrRange?: string | null; /** * User-defined labels. */ labels?: {[key: string]: string} | null; + /** + * Optional. Should be present if usage is set to FOR_MIGRATION. + */ + migration?: Schema$Migration; /** * Immutable. The name of an internal range. Format: projects/{project\}/locations/{location\}/internalRanges/{internal_range\} See: https://google.aip.dev/122#fields-representing-resource-names */ @@ -554,7 +566,7 @@ export namespace networkconnectivity_v1 { */ peering?: string | null; /** - * An alternate to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. + * An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. */ prefixLength?: number | null; /** @@ -579,7 +591,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$LinkedInterconnectAttachments { /** - * Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is "ALL_IPV4_RANGES". + * Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is "ALL_IPV4_RANGES". */ includeImportRanges?: string[] | null; /** @@ -595,12 +607,37 @@ export namespace networkconnectivity_v1 { */ vpcNetwork?: string | null; } + /** + * Next ID: 7 + */ + export interface Schema$LinkedProducerVpcNetwork { + /** + * Optional. IP ranges encompassing the subnets to be excluded from peering. + */ + excludeExportRanges?: string[] | null; + /** + * Immutable. The URI of the Service Consumer VPC that the Producer VPC is peered with. + */ + network?: string | null; + /** + * Immutable. The name of the VPC peering between the Service Consumer VPC and the Producer VPC (defined in the Tenant project) which is added to the NCC hub. This peering must be in ACTIVE state. + */ + peering?: string | null; + /** + * Output only. The URI of the Producer VPC. + */ + producerNetwork?: string | null; + /** + * Output only. The Service Consumer Network spoke. + */ + serviceConsumerVpcSpoke?: string | null; + } /** * A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. */ export interface Schema$LinkedRouterApplianceInstances { /** - * Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is "ALL_IPV4_RANGES". + * Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is "ALL_IPV4_RANGES". */ includeImportRanges?: string[] | null; /** @@ -642,7 +679,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$LinkedVpnTunnels { /** - * Optional. IP ranges allowed to be included during import from hub.(does not control transit connectivity) The only allowed value for now is "ALL_IPV4_RANGES". + * Optional. IP ranges allowed to be included during import from hub (does not control transit connectivity). The only allowed value for now is "ALL_IPV4_RANGES". */ includeImportRanges?: string[] | null; /** @@ -926,6 +963,19 @@ export namespace networkconnectivity_v1 { */ locationFeatures?: string[] | null; } + /** + * Specification for migration with source and target resource names. + */ + export interface Schema$Migration { + /** + * Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} + */ + source?: string | null; + /** + * Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} + */ + target?: string | null; + } /** * A route next hop that leads to an interconnect attachment resource. */ @@ -1149,7 +1199,7 @@ export namespace networkconnectivity_v1 { */ consumerTargetProject?: string | null; /** - * The most recent error during operating this connection. + * The most recent error during operating this connection. Deprecated, please use error_info instead. */ error?: Schema$GoogleRpcStatus; /** @@ -1165,9 +1215,13 @@ export namespace networkconnectivity_v1 { */ gceOperation?: string | null; /** - * Immutable. An immutable identifier for the producer instance. + * Immutable. Deprecated. Use producer_instance_metadata instead. An immutable identifier for the producer instance. */ producerInstanceId?: string | null; + /** + * Immutable. An immutable map for the producer instance metadata. + */ + producerInstanceMetadata?: {[key: string]: string} | null; /** * The PSC connection id of the PSC forwarding rule. */ @@ -1176,6 +1230,10 @@ export namespace networkconnectivity_v1 { * Output only. The URI of the subnetwork selected to allocate IP address for this connection. */ selectedSubnetwork?: string | null; + /** + * Output only. [Output only] The service class associated with this PSC Connection. The value is derived from the SCPolicy and matches the service class name provided by the customer. + */ + serviceClass?: string | null; /** * State of the PSC Connection */ @@ -1480,7 +1538,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$ServiceConnectionPolicy { /** - * Output only. Time when the ServiceConnectionMap was created. + * Output only. Time when the ServiceConnectionPolicy was created. */ createTime?: string | null; /** @@ -1520,7 +1578,7 @@ export namespace networkconnectivity_v1 { */ serviceClass?: string | null; /** - * Output only. Time when the ServiceConnectionMap was updated. + * Output only. Time when the ServiceConnectionPolicy was updated. */ updateTime?: string | null; } @@ -1606,6 +1664,10 @@ export namespace networkconnectivity_v1 { * VLAN attachments that are associated with the spoke. */ linkedInterconnectAttachments?: Schema$LinkedInterconnectAttachments; + /** + * Optional. The linked producer VPC that is associated with the spoke. + */ + linkedProducerVpcNetwork?: Schema$LinkedProducerVpcNetwork; /** * Router appliance instances that are associated with the spoke. */ diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index 871955ded4..b6d1ad5462 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -301,7 +301,7 @@ export namespace networkconnectivity_v1alpha1 { */ description?: string | null; /** - * IP range that this internal range defines. + * 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. */ ipCidrRange?: string | null; /** @@ -329,7 +329,7 @@ export namespace networkconnectivity_v1alpha1 { */ peering?: string | null; /** - * An alternative to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. + * An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. */ prefixLength?: number | null; /** diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index 29c9ede817..eede780e84 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -495,6 +495,14 @@ export namespace networkmanagement_v1 { * 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. */ projectId?: string | null; + /** + * A [Redis Cluster](https://cloud.google.com/memorystore/docs/cluster) URI. + */ + redisCluster?: string | null; + /** + * A [Redis Instance](https://cloud.google.com/memorystore/docs/redis) URI. + */ + redisInstance?: string | null; } /** * For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. @@ -987,7 +995,7 @@ export namespace networkmanagement_v1 { type?: string | null; } /** - * For display only. Metadata associated with a Compute Engine network. + * For display only. Metadata associated with a Compute Engine network. Next ID: 7 */ export interface Schema$NetworkInfo { /** @@ -995,9 +1003,17 @@ export namespace networkmanagement_v1 { */ displayName?: string | null; /** - * The IP range that matches the test. + * The IP range of the subnet matching the source IP address of the test. */ matchedIpRange?: string | null; + /** + * URI of the subnet matching the source IP address of the test. + */ + matchedSubnetUri?: string | null; + /** + * The region of the subnet matching the source IP address of the test. + */ + region?: string | null; /** * URI of a Compute Engine network. */ @@ -1193,6 +1209,35 @@ export namespace networkmanagement_v1 { */ verifyTime?: string | null; } + /** + * For display only. Metadata associated with a Redis Cluster. + */ + export interface Schema$RedisClusterInfo { + /** + * Discovery endpoint IP address of a Redis Cluster. + */ + discoveryEndpointIpAddress?: string | null; + /** + * Name of a Redis Cluster. + */ + displayName?: string | null; + /** + * Name of the region in which the Redis Cluster is defined. For example, "us-central1". + */ + location?: string | null; + /** + * URI of a Redis Cluster network in format "projects/{project_id\}/global/networks/{network_id\}". + */ + networkUri?: string | null; + /** + * Secondary endpoint IP address of a Redis Cluster. + */ + secondaryEndpointIpAddress?: string | null; + /** + * URI of a Redis Cluster in format "projects/{project_id\}/locations/{location\}/clusters/{cluster_id\}" + */ + uri?: string | null; + } /** * For display only. Metadata associated with a Cloud Redis Instance. */ @@ -1230,6 +1275,14 @@ export namespace networkmanagement_v1 { * For display only. Metadata associated with a Compute Engine route. */ export interface Schema$RouteInfo { + /** + * For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network. + */ + advertisedRouteNextHopUri?: string | null; + /** + * For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix. + */ + advertisedRouteSourceRouterUri?: string | null; /** * Destination IP range of the route. */ @@ -1274,6 +1327,10 @@ export namespace networkmanagement_v1 { * Protocols of the route. Policy based routes only. */ protocols?: string[] | null; + /** + * Region of the route (if applicable). + */ + region?: string | null; /** * Indicates where route is applicable. */ @@ -1291,7 +1348,7 @@ export namespace networkmanagement_v1 { */ srcPortRanges?: string[] | null; /** - * URI of a route. Dynamic, peering static and peering dynamic routes do not have an URI. Advertised route from Google Cloud VPC to on-premises network also does not have an URI. + * URI of a route (if applicable). */ uri?: string | null; } @@ -1426,6 +1483,10 @@ export namespace networkmanagement_v1 { * Display information of a ProxyConnection. */ proxyConnection?: Schema$ProxyConnectionInfo; + /** + * Display information of a Redis Cluster. + */ + redisCluster?: Schema$RedisClusterInfo; /** * Display information of a Redis Instance. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index df41f3eaf3..0e5b39c197 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -1016,7 +1016,7 @@ export namespace networkmanagement_v1beta1 { type?: string | null; } /** - * For display only. Metadata associated with a Compute Engine network. + * For display only. Metadata associated with a Compute Engine network. Next ID: 7 */ export interface Schema$NetworkInfo { /** @@ -1024,9 +1024,17 @@ export namespace networkmanagement_v1beta1 { */ displayName?: string | null; /** - * The IP range that matches the test. + * The IP range of the subnet matching the source IP address of the test. */ matchedIpRange?: string | null; + /** + * URI of the subnet matching the source IP address of the test. + */ + matchedSubnetUri?: string | null; + /** + * The region of the subnet matching the source IP address of the test. + */ + region?: string | null; /** * URI of a Compute Engine network. */ @@ -1222,6 +1230,35 @@ export namespace networkmanagement_v1beta1 { */ verifyTime?: string | null; } + /** + * For display only. Metadata associated with a Redis Cluster. + */ + export interface Schema$RedisClusterInfo { + /** + * Discovery endpoint IP address of a Redis Cluster. + */ + discoveryEndpointIpAddress?: string | null; + /** + * Name of a Redis Cluster. + */ + displayName?: string | null; + /** + * Name of the region in which the Redis Cluster is defined. For example, "us-central1". + */ + location?: string | null; + /** + * URI of a Redis Cluster network in format "projects/{project_id\}/global/networks/{network_id\}". + */ + networkUri?: string | null; + /** + * Secondary endpoint IP address of a Redis Cluster. + */ + secondaryEndpointIpAddress?: string | null; + /** + * URI of a Redis Cluster in format "projects/{project_id\}/locations/{location\}/clusters/{cluster_id\}" + */ + uri?: string | null; + } /** * For display only. Metadata associated with a Cloud Redis Instance. */ @@ -1259,6 +1296,14 @@ export namespace networkmanagement_v1beta1 { * For display only. Metadata associated with a Compute Engine route. */ export interface Schema$RouteInfo { + /** + * For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network. + */ + advertisedRouteNextHopUri?: string | null; + /** + * For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix. + */ + advertisedRouteSourceRouterUri?: string | null; /** * Destination IP range of the route. */ @@ -1303,6 +1348,10 @@ export namespace networkmanagement_v1beta1 { * Protocols of the route. Policy based routes only. */ protocols?: string[] | null; + /** + * Region of the route (if applicable). + */ + region?: string | null; /** * Indicates where route is applicable. */ @@ -1320,7 +1369,7 @@ export namespace networkmanagement_v1beta1 { */ srcPortRanges?: string[] | null; /** - * URI of a route. Dynamic, peering static and peering dynamic routes do not have an URI. Advertised route from Google Cloud VPC to on-premises network also does not have an URI. + * URI of a route (if applicable). */ uri?: string | null; } @@ -1455,6 +1504,10 @@ export namespace networkmanagement_v1beta1 { * Display information of a ProxyConnection. */ proxyConnection?: Schema$ProxyConnectionInfo; + /** + * Display information of a Redis Cluster. + */ + redisCluster?: Schema$RedisClusterInfo; /** * Display information of a Redis Instance. */ diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index 800b58932c..0faf4cdb63 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -280,6 +280,15 @@ export namespace networksecurity_v1 { */ sourceAddressGroup?: string | null; } + /** + * CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup + */ + export interface Schema$CustomMirroringProfile { + /** + * Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + */ + mirroringEndpointGroup?: string | null; + } /** * Specification of traffic destination attributes. */ @@ -999,6 +1008,10 @@ export namespace networksecurity_v1 { * Output only. Resource creation timestamp. */ createTime?: string | null; + /** + * The custom Packet Mirroring v2 configuration for the SecurityProfile. + */ + customMirroringProfile?: Schema$CustomMirroringProfile; /** * Optional. An optional description of the profile. Max length 512 characters. */ @@ -1036,6 +1049,10 @@ export namespace networksecurity_v1 { * Output only. Resource creation timestamp. */ createTime?: string | null; + /** + * Optional. Reference to a SecurityProfile with the CustomMirroring configuration. + */ + customMirroringProfile?: string | null; /** * Optional. An optional description of the profile group. Max length 2048 characters. */ diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index f95fa6d0cf..ebbf8d43ee 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -222,7 +222,7 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicy { /** - * Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request. + * Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If there are no `ALLOW` policies for the resource or if any of the `ALLOW` policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with `ALLOW` action match the request. */ action?: string | null; /** @@ -230,7 +230,7 @@ export namespace networksecurity_v1beta1 { */ createTime?: string | null; /** - * Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified. + * Optional. Required if the action is `CUSTOM`. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of `cloudIap` or `authzExtension` must be specified. */ customProvider?: Schema$AuthzPolicyCustomProvider; /** @@ -238,7 +238,7 @@ export namespace networksecurity_v1beta1 { */ description?: string | null; /** - * Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. + * 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. */ httpRules?: Schema$AuthzPolicyAuthzRule[]; /** @@ -284,7 +284,7 @@ export namespace networksecurity_v1beta1 { */ notSources?: Schema$AuthzPolicyAuthzRuleFromRequestSource[]; /** - * Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + * Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 5 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. */ sources?: Schema$AuthzPolicyAuthzRuleFromRequestSource[]; } @@ -293,11 +293,11 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyAuthzRuleFromRequestSource { /** - * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals. + * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 5 principals. */ principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** - * Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources. + * Optional. A list of resources to match against the resource of the source VM of a request. Limited to 5 resources. */ resources?: Schema$AuthzPolicyAuthzRuleRequestResource[]; } @@ -332,7 +332,7 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyAuthzRuleRequestResourceTagValueIdSet { /** - * Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches. + * 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. */ ids?: string[] | null; } @@ -370,7 +370,7 @@ export namespace networksecurity_v1beta1 { */ notOperations?: Schema$AuthzPolicyAuthzRuleToRequestOperation[]; /** - * Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + * Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 5 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. */ operations?: Schema$AuthzPolicyAuthzRuleToRequestOperation[]; } @@ -383,7 +383,7 @@ export namespace networksecurity_v1beta1 { */ headerSet?: Schema$AuthzPolicyAuthzRuleToRequestOperationHeaderSet; /** - * Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. + * 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. */ hosts?: Schema$AuthzPolicyAuthzRuleStringMatch[]; /** @@ -391,7 +391,7 @@ export namespace networksecurity_v1beta1 { */ methods?: string[] | null; /** - * Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + * 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. */ paths?: Schema$AuthzPolicyAuthzRuleStringMatch[]; } @@ -400,7 +400,7 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyAuthzRuleToRequestOperationHeaderSet { /** - * Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. + * 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. */ headers?: Schema$AuthzPolicyAuthzRuleHeaderMatch[]; } @@ -435,7 +435,7 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$AuthzPolicyTarget { /** - * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * 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). */ loadBalancingScheme?: string | null; /** @@ -506,6 +506,15 @@ export namespace networksecurity_v1beta1 { */ sourceAddressGroup?: string | null; } + /** + * CustomMirroringProfile defines an action for mirroring traffic to a collector's EndpointGroup + */ + export interface Schema$CustomMirroringProfile { + /** + * Required. The MirroringEndpointGroup to which traffic associated with the SP should be mirrored. + */ + mirroringEndpointGroup?: string | null; + } /** * Specification of traffic destination attributes. */ @@ -1022,6 +1031,62 @@ export namespace networksecurity_v1beta1 { */ nextPageToken?: string | null; } + /** + * Message for response to listing MirroringDeploymentGroups + */ + export interface Schema$ListMirroringDeploymentGroupsResponse { + /** + * The list of MirroringDeploymentGroup + */ + mirroringDeploymentGroups?: Schema$MirroringDeploymentGroup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * Message for response to listing MirroringDeployments + */ + export interface Schema$ListMirroringDeploymentsResponse { + /** + * The list of MirroringDeployment + */ + mirroringDeployments?: Schema$MirroringDeployment[]; + /** + * 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 MirroringEndpointGroupAssociations + */ + export interface Schema$ListMirroringEndpointGroupAssociationsResponse { + /** + * The list of MirroringEndpointGroupAssociation + */ + mirroringEndpointGroupAssociations?: Schema$MirroringEndpointGroupAssociation[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * Message for response to listing MirroringEndpointGroups + */ + export interface Schema$ListMirroringEndpointGroupsResponse { + /** + * The list of MirroringEndpointGroup + */ + mirroringEndpointGroups?: Schema$MirroringEndpointGroup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } /** * The response message for Operations.ListOperations. */ @@ -1133,6 +1198,176 @@ export namespace networksecurity_v1beta1 { */ name?: string | null; } + /** + * Message describing MirroringDeployment object + */ + export interface Schema$MirroringDeployment { + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Required. Immutable. The regional load balancer which the mirrored traffic should be forwarded to. Format is: projects/{project\}/regions/{region\}/forwardingRules/{forwardingRule\} + */ + forwardingRule?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Immutable. The Mirroring Deployment Group that this resource is part of. Format is: `projects/{project\}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup\}` + */ + mirroringDeploymentGroup?: string | null; + /** + * Immutable. Identifier. The name of the MirroringDeployment. + */ + name?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the deployment. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message describing MirroringDeploymentGroup object + */ + export interface Schema$MirroringDeploymentGroup { + /** + * Output only. The list of Mirroring Endpoint Groups that are connected to this resource. + */ + connectedEndpointGroups?: Schema$MirroringDeploymentGroupConnectedEndpointGroup[]; + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Immutable. Identifier. Then name of the MirroringDeploymentGroup. + */ + name?: string | null; + /** + * Required. Immutable. The network that is being used for the deployment. Format is: projects/{project\}/global/networks/{network\}. + */ + network?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the deployment group. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * An endpoint group connected to this deployment group. + */ + export interface Schema$MirroringDeploymentGroupConnectedEndpointGroup { + /** + * Output only. A connected mirroring endpoint group. + */ + name?: string | null; + } + /** + * Message describing MirroringEndpointGroup object. Next ID: 10 + */ + export interface Schema$MirroringEndpointGroup { + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Required. Immutable. The Mirroring Deployment Group that this resource is connected to. Format is: `projects/{project\}/locations/global/mirroringDeploymentGroups/{mirroringDeploymentGroup\}` + */ + mirroringDeploymentGroup?: string | null; + /** + * Immutable. Identifier. The name of the MirroringEndpointGroup. + */ + name?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the endpoint group. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Message describing MirroringEndpointGroupAssociation object + */ + export interface Schema$MirroringEndpointGroupAssociation { + /** + * Output only. [Output only] Create time stamp + */ + createTime?: string | null; + /** + * Optional. Labels as key value pairs + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The list of locations that this association is in and its details. + */ + locationsDetails?: Schema$MirroringEndpointGroupAssociationLocationDetails[]; + /** + * Required. Immutable. The Mirroring Endpoint Group that this resource is connected to. Format is: `projects/{project\}/locations/global/mirroringEndpointGroups/{mirroringEndpointGroup\}` + */ + mirroringEndpointGroup?: string | null; + /** + * Immutable. Identifier. The name of the MirroringEndpointGroupAssociation. + */ + name?: string | null; + /** + * Required. Immutable. The VPC network associated. Format: projects/{project\}/global/networks/{network\}. + */ + network?: string | null; + /** + * Output only. Whether reconciling is in progress, recommended per https://google.aip.dev/128. + */ + reconciling?: boolean | null; + /** + * Output only. Current state of the endpoint group association. + */ + state?: string | null; + /** + * Output only. [Output only] Update time stamp + */ + updateTime?: string | null; + } + /** + * Details about the association status in a specific cloud location. + */ + export interface Schema$MirroringEndpointGroupAssociationLocationDetails { + /** + * Output only. The cloud location. + */ + location?: string | null; + /** + * Output only. The association state in this location. + */ + state?: string | null; + } /** * Specification of the MTLSPolicy. */ @@ -1242,6 +1477,10 @@ export namespace networksecurity_v1beta1 { * Output only. Resource creation timestamp. */ createTime?: string | null; + /** + * The custom Packet Mirroring v2 configuration for the SecurityProfile. + */ + customMirroringProfile?: Schema$CustomMirroringProfile; /** * Optional. An optional description of the profile. Max length 512 characters. */ @@ -1279,6 +1518,10 @@ export namespace networksecurity_v1beta1 { * Output only. Resource creation timestamp. */ createTime?: string | null; + /** + * Optional. Reference to a SecurityProfile with the CustomMirroring configuration. + */ + customMirroringProfile?: string | null; /** * Optional. An optional description of the profile group. Max length 2048 characters. */ @@ -4499,6 +4742,10 @@ export namespace networksecurity_v1beta1 { clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; + mirroringDeploymentGroups: Resource$Projects$Locations$Mirroringdeploymentgroups; + mirroringDeployments: Resource$Projects$Locations$Mirroringdeployments; + mirroringEndpointGroupAssociations: Resource$Projects$Locations$Mirroringendpointgroupassociations; + mirroringEndpointGroups: Resource$Projects$Locations$Mirroringendpointgroups; operations: Resource$Projects$Locations$Operations; serverTlsPolicies: Resource$Projects$Locations$Servertlspolicies; tlsInspectionPolicies: Resource$Projects$Locations$Tlsinspectionpolicies; @@ -4521,6 +4768,16 @@ export namespace networksecurity_v1beta1 { ); this.gatewaySecurityPolicies = new Resource$Projects$Locations$Gatewaysecuritypolicies(this.context); + this.mirroringDeploymentGroups = + new Resource$Projects$Locations$Mirroringdeploymentgroups(this.context); + this.mirroringDeployments = + new Resource$Projects$Locations$Mirroringdeployments(this.context); + this.mirroringEndpointGroupAssociations = + new Resource$Projects$Locations$Mirroringendpointgroupassociations( + this.context + ); + this.mirroringEndpointGroups = + new Resource$Projects$Locations$Mirroringendpointgroups(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -7675,7 +7932,7 @@ export namespace networksecurity_v1beta1 { */ requestId?: string; /** - * Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; @@ -10146,6 +10403,2178 @@ export namespace networksecurity_v1beta1 { requestBody?: Schema$GatewaySecurityPolicyRule; } + export class Resource$Projects$Locations$Mirroringdeploymentgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new MirroringDeploymentGroup 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$Mirroringdeploymentgroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringDeploymentGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single MirroringDeploymentGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single MirroringDeploymentGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 MirroringDeploymentGroups 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$Mirroringdeploymentgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringDeploymentGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a single MirroringDeploymentGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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$Mirroringdeploymentgroups$Create + extends StandardParameters { + /** + * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_group_id from the method_signature of Create RPC + */ + mirroringDeploymentGroupId?: 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$MirroringDeploymentGroup; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$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$Mirroringdeploymentgroups$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$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 ListMirroringDeploymentGroupsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeploymentgroups$Patch + extends StandardParameters { + /** + * Immutable. Identifier. Then name of the MirroringDeploymentGroup. + */ + 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 MirroringDeploymentGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeploymentGroup; + } + + export class Resource$Projects$Locations$Mirroringdeployments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new MirroringDeployment 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$Mirroringdeployments$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/mirroringDeployments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single MirroringDeployment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single MirroringDeployment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 MirroringDeployments 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$Mirroringdeployments$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringdeployments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/mirroringDeployments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a single MirroringDeployment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringdeployments$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringdeployments$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringdeployments$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringdeployments$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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$Mirroringdeployments$Create + extends StandardParameters { + /** + * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_deployment_id from the method_signature of Create RPC + */ + mirroringDeploymentId?: 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$MirroringDeployment; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$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$Mirroringdeployments$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$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 ListMirroringDeploymentsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringdeployments$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The name of the MirroringDeployment. + */ + 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 MirroringDeployment resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringDeployment; + } + + export class Resource$Projects$Locations$Mirroringendpointgroupassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new MirroringEndpointGroupAssociation 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$Mirroringendpointgroupassociations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringEndpointGroupAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single MirroringEndpointGroupAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single MirroringEndpointGroupAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 MirroringEndpointGroupAssociations 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$Mirroringendpointgroupassociations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringEndpointGroupAssociations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a single MirroringEndpointGroupAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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$Mirroringendpointgroupassociations$Create + extends StandardParameters { + /** + * Optional. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_association_id from the method_signature of Create RPC + */ + mirroringEndpointGroupAssociationId?: 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$MirroringEndpointGroupAssociation; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$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$Mirroringendpointgroupassociations$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$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 ListMirroringEndpointGroupAssociationsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroupassociations$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The name of the MirroringEndpointGroupAssociation. + */ + 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 MirroringEndpointGroupAssociation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroupAssociation; + } + + export class Resource$Projects$Locations$Mirroringendpointgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new MirroringEndpointGroup 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$Mirroringendpointgroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single MirroringEndpointGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single MirroringEndpointGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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 MirroringEndpointGroups 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$Mirroringendpointgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/mirroringEndpointGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a single MirroringEndpointGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/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$Mirroringendpointgroups$Create + extends StandardParameters { + /** + * Required. Id of the requesting object If auto-generating Id server-side, remove this field and mirroring_endpoint_group_id from the method_signature of Create RPC + */ + mirroringEndpointGroupId?: 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$MirroringEndpointGroup; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$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$Mirroringendpointgroups$Get + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$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 ListMirroringEndpointGroupsRequest + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Mirroringendpointgroups$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The name of the MirroringEndpointGroup. + */ + 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 MirroringEndpointGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MirroringEndpointGroup; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 5a895b2f89..627888d545 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -1084,7 +1084,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1125,7 +1125,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1347,6 +1347,15 @@ export namespace networkservices_v1 { */ name?: string | null; } + /** + * The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. + */ + export interface Schema$LoggingConfig { + /** + * Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. + */ + logSeverity?: string | null; + } /** * Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary. */ @@ -1463,6 +1472,12 @@ export namespace networkservices_v1 { */ version?: number | null; } + export interface Schema$RetryFilterPerRouteConfig { + /** + * The name of the crypto key to use for encrypting event data. + */ + cryptoKeyName?: string | null; + } /** * ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource. */ @@ -5605,7 +5620,7 @@ export namespace networkservices_v1 { */ 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 `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; @@ -6147,7 +6162,7 @@ export namespace networkservices_v1 { */ requestId?: string; /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; @@ -7751,96 +7766,6 @@ export namespace networkservices_v1 { } } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists ServiceLbPolicies in a given project and location. * @@ -8026,193 +7951,6 @@ export namespace networkservices_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$Servicelbpolicies$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Projects$Locations$Servicelbpolicies$Create @@ -8245,17 +7983,6 @@ export namespace networkservices_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicelbpolicies$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$Servicelbpolicies$List extends StandardParameters { /** @@ -8287,30 +8014,6 @@ export namespace networkservices_v1 { */ requestBody?: Schema$ServiceLbPolicy; } - export interface Params$Resource$Projects$Locations$Servicelbpolicies$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$Servicelbpolicies$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$Tcproutes { context: APIRequestContext; diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index 7c456c43b6..9b16e028ef 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -125,33 +125,7 @@ export namespace networkservices_v1beta1 { } /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. - */ - export interface Schema$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; - /** - * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. - */ - service?: string | null; - } - /** - * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. - */ - export interface Schema$AuditLogConfig { - /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. - */ - exemptedMembers?: string[] | null; - /** - * The log type that this config enables. - */ - logType?: string | null; - } - /** - * `AuthzExtension` is a resource that allows traffic forwarding to a callout backend to make an authorization decision. + * `AuthzExtension` is a resource that allows traffic forwarding to a callout backend service to make an authorization decision. */ export interface Schema$AuthzExtension { /** @@ -179,7 +153,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -191,7 +165,7 @@ export namespace networkservices_v1beta1 { */ name?: string | null; /** - * Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. + * 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\}`. */ service?: string | null; /** @@ -207,23 +181,6 @@ export namespace networkservices_v1beta1 { */ wireFormat?: string | null; } - /** - * Associates `members`, or principals, with a `role`. - */ - export interface Schema$Binding { - /** - * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - condition?: Schema$Expr; - /** - * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. - */ - members?: string[] | null; - /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). - */ - role?: string | null; - } /** * The request message for Operations.CancelOperation. */ @@ -290,27 +247,6 @@ export namespace networkservices_v1beta1 { */ updateTime?: string | null; } - /** - * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. - */ - export interface Schema$Expr { - /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - */ - description?: string | null; - /** - * Textual representation of an expression in Common Expression Language syntax. - */ - expression?: string | null; - /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - */ - location?: string | null; - /** - * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - */ - title?: string | null; - } /** * A single extension chain wrapper that contains the match conditions and extensions to execute. */ @@ -1115,7 +1051,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1156,7 +1092,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service). */ loadBalancingScheme?: string | null; /** @@ -1395,6 +1331,15 @@ export namespace networkservices_v1beta1 { */ name?: string | null; } + /** + * The configuration for Platform Telemetry logging for Eventarc Avdvanced resources. + */ + export interface Schema$LoggingConfig { + /** + * Optional. The minimum severity of logs that will be sent to Stackdriver/Platform Telemetry. Logs at severitiy ≥ this value will be sent, unless it is NONE. + */ + logSeverity?: string | null; + } /** * Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary. */ @@ -1516,26 +1461,11 @@ export namespace networkservices_v1beta1 { */ verb?: string | null; } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$Policy { + export interface Schema$RetryFilterPerRouteConfig { /** - * Specifies cloud audit logging configuration for this policy. + * The name of the crypto key to use for encrypting event data. */ - auditConfigs?: Schema$AuditConfig[]; - /** - * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. - */ - bindings?: Schema$Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - */ - etag?: string | null; - /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - version?: number | null; + cryptoKeyName?: string | null; } /** * ServiceBinding is the resource that defines a Service Directory Service to be used in a BackendService resource. @@ -1625,19 +1555,6 @@ export namespace networkservices_v1beta1 { */ failoverHealthThreshold?: number | null; } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$SetIamPolicyRequest { - /** - * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. - */ - policy?: Schema$Policy; - /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` - */ - updateMask?: string | null; - } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ @@ -1752,24 +1669,6 @@ export namespace networkservices_v1beta1 { */ matches?: Schema$TcpRouteRouteMatch[]; } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { - /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). - */ - permissions?: string[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[] | null; - } /** * TlsRoute defines how traffic should be routed based on SNI and other matching L3 attributes. */ @@ -2661,7 +2560,7 @@ export namespace networkservices_v1beta1 { */ requestId?: string; /** - * Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; @@ -5246,7 +5145,7 @@ 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 `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; @@ -5788,7 +5687,7 @@ export namespace networkservices_v1beta1 { */ requestId?: string; /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ updateMask?: string; @@ -7395,96 +7294,6 @@ export namespace networkservices_v1beta1 { } } - /** - * 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$Servicelbpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists ServiceLbPolicies in a given project and location. * @@ -7670,193 +7479,6 @@ export namespace networkservices_v1beta1 { 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$Servicelbpolicies$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicelbpolicies$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Projects$Locations$Servicelbpolicies$Create @@ -7889,17 +7511,6 @@ export namespace networkservices_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicelbpolicies$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$Servicelbpolicies$List extends StandardParameters { /** @@ -7931,30 +7542,6 @@ export namespace networkservices_v1beta1 { */ requestBody?: Schema$ServiceLbPolicy; } - export interface Params$Resource$Projects$Locations$Servicelbpolicies$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$Servicelbpolicies$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$Tcproutes { context: APIRequestContext; diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index c5ec129d2f..6ce617cdfe 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -641,7 +641,7 @@ export namespace notebooks_v1 { */ subnet?: string | null; /** - * Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). + * Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)). */ tags?: string[] | null; /** @@ -1729,7 +1729,7 @@ export namespace notebooks_v1 { */ subnet?: string | null; /** - * Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). + * Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)). */ tags?: string[] | null; /** diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index 6b884279af..b74180cebf 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -406,7 +406,7 @@ export namespace notebooks_v2 { */ shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; /** - * Optional. The Compute Engine tags to add to runtime (see [Tagging instances](https://cloud.google.com/compute/docs/label-or-tag-resources#tags)). + * Optional. The Compute Engine network tags to add to runtime (see [Add network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags)). */ tags?: string[] | null; /** diff --git a/src/apis/oracledatabase/README.md b/src/apis/oracledatabase/README.md new file mode 100644 index 0000000000..5c14426fec --- /dev/null +++ b/src/apis/oracledatabase/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# oracledatabase + +> The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases. + +## Installation + +```sh +$ npm install @googleapis/oracledatabase +``` + +## 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/oracledatabase/classes/Oracledatabase.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/oracledatabase/index.ts b/src/apis/oracledatabase/index.ts new file mode 100644 index 0000000000..1e8064d776 --- /dev/null +++ b/src/apis/oracledatabase/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 {oracledatabase_v1} from './v1'; + +export const VERSIONS = { + v1: oracledatabase_v1.Oracledatabase, +}; + +export function oracledatabase(version: 'v1'): oracledatabase_v1.Oracledatabase; +export function oracledatabase( + options: oracledatabase_v1.Options +): oracledatabase_v1.Oracledatabase; +export function oracledatabase( + this: GoogleConfigurable, + versionOrOptions: 'v1' | oracledatabase_v1.Options +) { + return getAPI('oracledatabase', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {oracledatabase_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/oracledatabase/package.json b/src/apis/oracledatabase/package.json new file mode 100644 index 0000000000..0a6e3dd75f --- /dev/null +++ b/src/apis/oracledatabase/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/oracledatabase", + "version": "0.1.0", + "description": "oracledatabase", + "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/oracledatabase/tsconfig.json b/src/apis/oracledatabase/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/oracledatabase/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/oracledatabase/v1.ts b/src/apis/oracledatabase/v1.ts new file mode 100644 index 0000000000..d542d7b974 --- /dev/null +++ b/src/apis/oracledatabase/v1.ts @@ -0,0 +1,4847 @@ +// 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 oracledatabase_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; + } + + /** + * Oracle Database@Google Cloud API + * + * The Oracle Database@Google Cloud API provides a set of APIs to manage Oracle database services, such as Exadata and Autonomous Databases. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const oracledatabase = google.oracledatabase('v1'); + * ``` + */ + export class Oracledatabase { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * A list of all connection strings that can be used to connect to the Autonomous Database. + */ + export interface Schema$AllConnectionStrings { + /** + * Output only. The database service provides the highest level of resources to each SQL statement. + */ + high?: string | null; + /** + * Output only. The database service provides the least level of resources to each SQL statement. + */ + low?: string | null; + /** + * Output only. The database service provides a lower level of resources to each SQL statement. + */ + medium?: string | null; + } + /** + * Details of the Autonomous Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabase/ + */ + export interface Schema$AutonomousDatabase { + /** + * Optional. The password for the default ADMIN user. + */ + adminPassword?: string | null; + /** + * Required. The subnet CIDR range for the Autonmous Database. + */ + cidr?: string | null; + /** + * Output only. The date and time that the Autonomous Database was created. + */ + createTime?: string | null; + /** + * 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; + /** + * Optional. The display name for the Autonomous Database. The name does not have to be unique within your project. + */ + displayName?: string | null; + /** + * Output only. The ID of the subscription entitlement associated with the Autonomous Database. + */ + entitlementId?: string | null; + /** + * Optional. The labels or tags associated with the Autonomous Database. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the Autonomous Database resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + */ + name?: string | null; + /** + * Required. The name of the VPC network used by the Autonomous Database in the following format: projects/{project\}/global/networks/{network\} + */ + network?: string | null; + /** + * Optional. The properties of the Autonomous Database. + */ + properties?: Schema$AutonomousDatabaseProperties; + } + /** + * Oracle APEX Application Development. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseApex + */ + export interface Schema$AutonomousDatabaseApex { + /** + * Output only. The Oracle APEX Application Development version. + */ + apexVersion?: string | null; + /** + * Output only. The Oracle REST Data Services (ORDS) version. + */ + ordsVersion?: string | null; + } + /** + * Details of the Autonomous Database Backup resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseBackup/ + */ + export interface Schema$AutonomousDatabaseBackup { + /** + * Required. The name of the Autonomous Database resource for which the backup is being created. Format: projects/{project\}/locations/{region\}/autonomousDatabases/{autonomous_database\} + */ + autonomousDatabase?: string | null; + /** + * Optional. User friendly name for the Backup. The name does not have to be unique. + */ + displayName?: string | null; + /** + * Optional. labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the Autonomous Database Backup resource with the format: projects/{project\}/locations/{region\}/autonomousDatabaseBackups/{autonomous_database_backup\} + */ + name?: string | null; + /** + * Optional. Various properties of the backup. + */ + properties?: Schema$AutonomousDatabaseBackupProperties; + } + /** + * Properties of the Autonomous Database Backup resource. + */ + export interface Schema$AutonomousDatabaseBackupProperties { + /** + * Output only. Timestamp until when the backup will be available. + */ + availableTillTime?: string | null; + /** + * Output only. The OCID of the compartment. + */ + compartmentId?: string | null; + /** + * Output only. The quantity of data in the database, in terabytes. + */ + databaseSizeTb?: number | null; + /** + * Output only. A valid Oracle Database version for Autonomous Database. + */ + dbVersion?: string | null; + /** + * Output only. The date and time the backup completed. + */ + endTime?: string | null; + /** + * Output only. Indicates if the backup is automatic or user initiated. + */ + isAutomaticBackup?: boolean | null; + /** + * Output only. Indicates if the backup is long term backup. + */ + isLongTermBackup?: boolean | null; + /** + * Output only. Indicates if the backup can be used to restore the Autonomous Database. + */ + isRestorable?: boolean | null; + /** + * Optional. The OCID of the key store of Oracle Vault. + */ + keyStoreId?: string | null; + /** + * Optional. The wallet name for Oracle Key Vault. + */ + keyStoreWallet?: string | null; + /** + * Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. + */ + kmsKeyId?: string | null; + /** + * Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances. + */ + kmsKeyVersionId?: string | null; + /** + * Output only. Additional information about the current lifecycle state. + */ + lifecycleDetails?: string | null; + /** + * Output only. The lifecycle state of the backup. + */ + lifecycleState?: string | null; + /** + * Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ + ocid?: string | null; + /** + * Optional. Retention period in days for the backup. + */ + retentionPeriodDays?: number | null; + /** + * Output only. The backup size in terabytes. + */ + sizeTb?: number | null; + /** + * Output only. The date and time the backup started. + */ + startTime?: string | null; + /** + * Output only. The type of the backup. + */ + type?: string | null; + /** + * Optional. The OCID of the vault. + */ + vaultId?: string | null; + } + /** + * Details of the Autonomous Database character set resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDatabaseCharacterSets/ + */ + export interface Schema$AutonomousDatabaseCharacterSet { + /** + * Output only. The character set name for the Autonomous Database which is the ID in the resource name. + */ + characterSet?: string | null; + /** + * Output only. The character set type for the Autonomous Database. + */ + characterSetType?: string | null; + /** + * Identifier. The name of the Autonomous Database Character Set resource in the following format: projects/{project\}/locations/{region\}/autonomousDatabaseCharacterSets/{autonomous_database_character_set\} + */ + name?: string | null; + } + /** + * The connection string used to connect to the Autonomous Database. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionStrings + */ + export interface Schema$AutonomousDatabaseConnectionStrings { + /** + * Output only. Returns all connection strings that can be used to connect to the Autonomous Database. + */ + allConnectionStrings?: Schema$AllConnectionStrings; + /** + * Output only. The database service provides the least level of resources to each SQL statement, but supports the most number of concurrent SQL statements. + */ + dedicated?: string | null; + /** + * Output only. The database service provides the highest level of resources to each SQL statement. + */ + high?: string | null; + /** + * Output only. The database service provides the least level of resources to each SQL statement. + */ + low?: string | null; + /** + * Output only. The database service provides a lower level of resources to each SQL statement. + */ + medium?: string | null; + /** + * Output only. A list of connection string profiles to allow clients to group, filter, and select values based on the structured metadata. + */ + profiles?: Schema$DatabaseConnectionStringProfile[]; + } + /** + * The URLs for accessing Oracle Application Express (APEX) and SQL Developer Web with a browser from a Compute instance. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseConnectionUrls + */ + export interface Schema$AutonomousDatabaseConnectionUrls { + /** + * Output only. Oracle Application Express (APEX) URL. + */ + apexUri?: string | null; + /** + * Output only. The URL of the Database Transforms for the Autonomous Database. + */ + databaseTransformsUri?: string | null; + /** + * Output only. The URL of the Graph Studio for the Autonomous Database. + */ + graphStudioUri?: string | null; + /** + * Output only. The URL of the Oracle Machine Learning (OML) Notebook for the Autonomous Database. + */ + machineLearningNotebookUri?: string | null; + /** + * Output only. The URL of Machine Learning user management the Autonomous Database. + */ + machineLearningUserManagementUri?: string | null; + /** + * Output only. The URL of the MongoDB API for the Autonomous Database. + */ + mongoDbUri?: string | null; + /** + * Output only. The Oracle REST Data Services (ORDS) URL of the Web Access for the Autonomous Database. + */ + ordsUri?: string | null; + /** + * Output only. The URL of the Oracle SQL Developer Web for the Autonomous Database. + */ + sqlDevWebUri?: string | null; + } + /** + * The properties of an Autonomous Database. + */ + export interface Schema$AutonomousDatabaseProperties { + /** + * Output only. The amount of storage currently being used for user and system data, in terabytes. + */ + actualUsedDataStorageSizeTb?: number | null; + /** + * Output only. The amount of storage currently allocated for the database tables and billed for, rounded up in terabytes. + */ + allocatedStorageSizeTb?: number | null; + /** + * Output only. The details for the Oracle APEX Application Development. + */ + apexDetails?: Schema$AutonomousDatabaseApex; + /** + * Output only. This field indicates the status of Data Guard and Access control for the Autonomous Database. The field's value is null if Data Guard is disabled or Access Control is disabled. The field's value is TRUE if both Data Guard and Access Control are enabled, and the Autonomous Database is using primary IP access control list (ACL) for standby. The field's value is FALSE if both Data Guard and Access Control are enabled, and the Autonomous Database is using a different IP access control list (ACL) for standby compared to primary. + */ + arePrimaryAllowlistedIpsUsed?: boolean | null; + /** + * Output only. The Autonomous Container Database OCID. + */ + autonomousContainerDatabaseId?: string | null; + /** + * Output only. The list of available Oracle Database upgrade versions for an Autonomous Database. + */ + availableUpgradeVersions?: string[] | null; + /** + * Optional. The retention period for the Autonomous Database. This field is specified in days, can range from 1 day to 60 days, and has a default value of 60 days. + */ + backupRetentionPeriodDays?: number | null; + /** + * Optional. The character set for the Autonomous Database. The default is AL32UTF8. + */ + characterSet?: string | null; + /** + * Optional. The number of compute servers for the Autonomous Database. + */ + computeCount?: number | null; + /** + * Output only. The connection strings used to connect to an Autonomous Database. + */ + connectionStrings?: Schema$AutonomousDatabaseConnectionStrings; + /** + * Output only. The Oracle Connection URLs for an Autonomous Database. + */ + connectionUrls?: Schema$AutonomousDatabaseConnectionUrls; + /** + * Optional. The number of CPU cores to be made available to the database. + */ + cpuCoreCount?: number | null; + /** + * Optional. The list of customer contacts. + */ + customerContacts?: Schema$CustomerContact[]; + /** + * Output only. The current state of database management for the Autonomous Database. + */ + databaseManagementState?: string | null; + /** + * Output only. The current state of the Data Safe registration for the Autonomous Database. + */ + dataSafeState?: string | null; + /** + * Optional. The size of the data stored in the database, in gigabytes. + */ + dataStorageSizeGb?: number | null; + /** + * Optional. The size of the data stored in the database, in terabytes. + */ + dataStorageSizeTb?: number | null; + /** + * Optional. The edition of the Autonomous Databases. + */ + dbEdition?: string | null; + /** + * Optional. The Oracle Database version for the Autonomous Database. + */ + dbVersion?: string | null; + /** + * Required. The workload type of the Autonomous Database. + */ + dbWorkload?: string | null; + /** + * Output only. This field indicates the number of seconds of data loss during a Data Guard failover. + */ + failedDataRecoveryDuration?: string | null; + /** + * Optional. This field indicates if auto scaling is enabled for the Autonomous Database CPU core count. + */ + isAutoScalingEnabled?: boolean | null; + /** + * Output only. This field indicates whether the Autonomous Database has local (in-region) Data Guard enabled. + */ + isLocalDataGuardEnabled?: boolean | null; + /** + * Optional. This field indicates if auto scaling is enabled for the Autonomous Database storage. + */ + isStorageAutoScalingEnabled?: boolean | null; + /** + * Required. The license type used for the Autonomous Database. + */ + licenseType?: string | null; + /** + * Output only. The details of the current lifestyle state of the Autonomous Database. + */ + lifecycleDetails?: string | null; + /** + * Output only. This field indicates the maximum data loss limit for an Autonomous Database, in seconds. + */ + localAdgAutoFailoverMaxDataLossLimit?: number | null; + /** + * Output only. This field indicates the local disaster recovery (DR) type of an Autonomous Database. + */ + localDisasterRecoveryType?: string | null; + /** + * Output only. The details of the Autonomous Data Guard standby database. + */ + localStandbyDb?: Schema$AutonomousDatabaseStandbySummary; + /** + * Output only. The date and time when maintenance will begin. + */ + maintenanceBeginTime?: string | null; + /** + * Output only. The date and time when maintenance will end. + */ + maintenanceEndTime?: string | null; + /** + * Optional. The maintenance schedule of the Autonomous Database. + */ + maintenanceScheduleType?: string | null; + /** + * Output only. The amount of memory enabled per ECPU, in gigabytes. + */ + memoryPerOracleComputeUnitGbs?: number | null; + /** + * Output only. The memory assigned to in-memory tables in an Autonomous Database. + */ + memoryTableGbs?: number | null; + /** + * Optional. This field specifies if the Autonomous Database requires mTLS connections. + */ + mtlsConnectionRequired?: boolean | null; + /** + * Optional. The national character set for the Autonomous Database. The default is AL16UTF16. + */ + nCharacterSet?: string | null; + /** + * Output only. The long term backup schedule of the Autonomous Database. + */ + nextLongTermBackupTime?: string | null; + /** + * Output only. OCID of the Autonomous Database. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ + ocid?: string | null; + /** + * Output only. The Oracle Cloud Infrastructure link for the Autonomous Database. + */ + ociUrl?: string | null; + /** + * Output only. This field indicates the current mode of the Autonomous Database. + */ + openMode?: string | null; + /** + * Output only. This field indicates the state of Operations Insights for the Autonomous Database. + */ + operationsInsightsState?: string | null; + /** + * Output only. The list of OCIDs of standby databases located in Autonomous Data Guard remote regions that are associated with the source database. + */ + peerDbIds?: string[] | null; + /** + * Output only. The permission level of the Autonomous Database. + */ + permissionLevel?: string | null; + /** + * Output only. The private endpoint for the Autonomous Database. + */ + privateEndpoint?: string | null; + /** + * Optional. The private endpoint IP address for the Autonomous Database. + */ + privateEndpointIp?: string | null; + /** + * Optional. The private endpoint label for the Autonomous Database. + */ + privateEndpointLabel?: string | null; + /** + * Output only. The refresh mode of the cloned Autonomous Database. + */ + refreshableMode?: string | null; + /** + * Output only. The refresh State of the clone. + */ + refreshableState?: string | null; + /** + * Output only. The Data Guard role of the Autonomous Database. + */ + role?: string | null; + /** + * Output only. The list and details of the scheduled operations of the Autonomous Database. + */ + scheduledOperationDetails?: Schema$ScheduledOperationDetails[]; + /** + * Optional. The ID of the Oracle Cloud Infrastructure vault secret. + */ + secretId?: string | null; + /** + * Output only. The SQL Web Developer URL for the Autonomous Database. + */ + sqlWebDeveloperUrl?: string | null; + /** + * Output only. The current lifecycle state of the Autonomous Database. + */ + state?: string | null; + /** + * Output only. The list of available regions that can be used to create a clone for the Autonomous Database. + */ + supportedCloneRegions?: string[] | null; + /** + * Output only. The storage space used by automatic backups of Autonomous Database, in gigabytes. + */ + totalAutoBackupStorageSizeGbs?: number | null; + /** + * Output only. The storage space used by Autonomous Database, in gigabytes. + */ + usedDataStorageSizeTbs?: number | null; + /** + * Optional. The ID of the Oracle Cloud Infrastructure vault. + */ + vaultId?: string | null; + } + /** + * Autonomous Data Guard standby database details. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/AutonomousDatabaseStandbySummary + */ + export interface Schema$AutonomousDatabaseStandbySummary { + /** + * Output only. The date and time the Autonomous Data Guard role was switched for the standby Autonomous Database. + */ + dataGuardRoleChangedTime?: string | null; + /** + * Output only. The date and time the Disaster Recovery role was switched for the standby Autonomous Database. + */ + disasterRecoveryRoleChangedTime?: string | null; + /** + * Output only. The amount of time, in seconds, that the data of the standby database lags in comparison to the data of the primary database. + */ + lagTimeDuration?: string | null; + /** + * Output only. The additional details about the current lifecycle state of the Autonomous Database. + */ + lifecycleDetails?: string | null; + /** + * Output only. The current lifecycle state of the Autonomous Database. + */ + state?: string | null; + } + /** + * Details of the Autonomous Database version. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/AutonomousDbVersionSummary/ + */ + export interface Schema$AutonomousDbVersion { + /** + * Output only. The Autonomous Database workload type. + */ + dbWorkload?: string | null; + /** + * Identifier. The name of the Autonomous Database Version resource with the format: projects/{project\}/locations/{region\}/autonomousDbVersions/{autonomous_db_version\} + */ + name?: string | null; + /** + * Output only. An Oracle Database version for Autonomous Database. + */ + version?: string | null; + /** + * Output only. A URL that points to a detailed description of the Autonomous Database version. + */ + workloadUri?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * Details of the OCI Cloud Account. + */ + export interface Schema$CloudAccountDetails { + /** + * Output only. URL to create a new account and link. + */ + accountCreationUri?: string | null; + /** + * Output only. OCI account name. + */ + cloudAccount?: string | null; + /** + * Output only. OCI account home region. + */ + cloudAccountHomeRegion?: string | null; + /** + * Output only. URL to link an existing account. + */ + linkExistingAccountUri?: string | null; + } + /** + * Represents CloudExadataInfrastructure resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudExadataInfrastructure/ + */ + export interface Schema$CloudExadataInfrastructure { + /** + * Output only. The date and time that the Exadata Infrastructure was created. + */ + createTime?: string | null; + /** + * Optional. User friendly name for this resource. + */ + displayName?: string | null; + /** + * Output only. Entitlement ID of the private offer against which this infrastructure resource is provisioned. + */ + entitlementId?: string | null; + /** + * Optional. Google Cloud Platform location where Oracle Exadata is hosted. + */ + gcpOracleZone?: string | null; + /** + * Optional. Labels or tags associated with the resource. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the Exadata Infrastructure resource with the format: projects/{project\}/locations/{region\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\} + */ + name?: string | null; + /** + * Optional. Various properties of the infra. + */ + properties?: Schema$CloudExadataInfrastructureProperties; + } + /** + * Various properties of Exadata Infrastructure. + */ + export interface Schema$CloudExadataInfrastructureProperties { + /** + * Output only. The requested number of additional storage servers activated for the Exadata Infrastructure. + */ + activatedStorageCount?: number | null; + /** + * Output only. The requested number of additional storage servers for the Exadata Infrastructure. + */ + additionalStorageCount?: number | null; + /** + * Output only. The available storage can be allocated to the Exadata Infrastructure resource, in gigabytes (GB). + */ + availableStorageSizeGb?: number | null; + /** + * Optional. The number of compute servers for the Exadata Infrastructure. + */ + computeCount?: number | null; + /** + * Optional. The number of enabled CPU cores. + */ + cpuCount?: number | null; + /** + * Optional. The list of customer contacts. + */ + customerContacts?: Schema$CustomerContact[]; + /** + * Output only. Size, in terabytes, of the DATA disk group. + */ + dataStorageSizeTb?: number | null; + /** + * Optional. The local node storage allocated in GBs. + */ + dbNodeStorageSizeGb?: number | null; + /** + * Output only. The software version of the database servers (dom0) in the Exadata Infrastructure. + */ + dbServerVersion?: string | null; + /** + * Optional. Maintenance window for repair. + */ + maintenanceWindow?: Schema$MaintenanceWindow; + /** + * Output only. The total number of CPU cores available. + */ + maxCpuCount?: number | null; + /** + * Output only. The total available DATA disk group size. + */ + maxDataStorageTb?: number | null; + /** + * Output only. The total local node storage available in GBs. + */ + maxDbNodeStorageSizeGb?: number | null; + /** + * Output only. The total memory available in GBs. + */ + maxMemoryGb?: number | null; + /** + * Optional. The memory allocated in GBs. + */ + memorySizeGb?: number | null; + /** + * Output only. The monthly software version of the database servers (dom0) in the Exadata Infrastructure. Example: 20.1.15 + */ + monthlyDbServerVersion?: string | null; + /** + * Output only. The monthly software version of the storage servers (cells) in the Exadata Infrastructure. Example: 20.1.15 + */ + monthlyStorageServerVersion?: string | null; + /** + * Output only. The OCID of the next maintenance run. + */ + nextMaintenanceRunId?: string | null; + /** + * Output only. The time when the next maintenance run will occur. + */ + nextMaintenanceRunTime?: string | null; + /** + * Output only. The time when the next security maintenance run will occur. + */ + nextSecurityMaintenanceRunTime?: string | null; + /** + * Output only. OCID of created infra. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle + */ + ocid?: string | null; + /** + * Output only. Deep link to the OCI console to view this resource. + */ + ociUrl?: string | null; + /** + * Required. The shape of the Exadata Infrastructure. The shape determines the amount of CPU, storage, and memory resources allocated to the instance. + */ + shape?: string | null; + /** + * Output only. The current lifecycle state of the Exadata Infrastructure. + */ + state?: string | null; + /** + * Optional. The number of Cloud Exadata storage servers for the Exadata Infrastructure. + */ + storageCount?: number | null; + /** + * Output only. The software version of the storage servers (cells) in the Exadata Infrastructure. + */ + storageServerVersion?: string | null; + /** + * Optional. The total storage allocated to the Exadata Infrastructure resource, in gigabytes (GB). + */ + totalStorageSizeGb?: number | null; + } + /** + * Details of the Cloud VM Cluster resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/CloudVmCluster/ + */ + export interface Schema$CloudVmCluster { + /** + * Required. CIDR range of the backup subnet. + */ + backupSubnetCidr?: string | null; + /** + * Required. Network settings. CIDR to use for cluster IP allocation. + */ + cidr?: string | null; + /** + * Output only. The date and time that the VM cluster was created. + */ + createTime?: string | null; + /** + * Optional. User friendly name for this resource. + */ + displayName?: string | null; + /** + * Required. The name of the Exadata Infrastructure resource on which VM cluster resource is created, in the following format: projects/{project\}/locations/{region\}/cloudExadataInfrastuctures/{cloud_extradata_infrastructure\} + */ + exadataInfrastructure?: string | null; + /** + * Output only. Google Cloud Platform location where Oracle Exadata is hosted. It is same as Google Cloud Platform Oracle zone of Exadata infrastructure. + */ + gcpOracleZone?: string | null; + /** + * Optional. Labels or tags associated with the VM Cluster. + */ + labels?: {[key: string]: string} | null; + /** + * Identifier. The name of the VM Cluster resource with the format: projects/{project\}/locations/{region\}/cloudVmClusters/{cloud_vm_cluster\} + */ + name?: string | null; + /** + * Required. The name of the VPC network. Format: projects/{project\}/global/networks/{network\} + */ + network?: string | null; + /** + * Optional. Various properties of the VM Cluster. + */ + properties?: Schema$CloudVmClusterProperties; + } + /** + * Various properties and settings associated with Exadata VM cluster. + */ + export interface Schema$CloudVmClusterProperties { + /** + * Optional. OCI Cluster name. + */ + clusterName?: string | null; + /** + * Output only. Compartment ID of cluster. + */ + compartmentId?: string | null; + /** + * Required. Number of enabled CPU cores. + */ + cpuCoreCount?: number | null; + /** + * Optional. The data disk group size to be allocated in TBs. + */ + dataStorageSizeTb?: number | null; + /** + * Optional. Local storage per VM. + */ + dbNodeStorageSizeGb?: number | null; + /** + * Optional. OCID of database servers. + */ + dbServerOcids?: string[] | null; + /** + * Optional. Data collection options for diagnostics. + */ + diagnosticsDataCollectionOptions?: Schema$DataCollectionOptions; + /** + * Optional. The type of redundancy. + */ + diskRedundancy?: string | null; + /** + * Output only. DNS listener IP. + */ + dnsListenerIp?: string | null; + /** + * Output only. Parent DNS domain where SCAN DNS and hosts names are qualified. ex: ocispdelegated.ocisp10jvnet.oraclevcn.com + */ + domain?: string | null; + /** + * Optional. Grid Infrastructure Version. + */ + giVersion?: string | null; + /** + * Output only. host name without domain. format: "-" with some suffix. ex: sp2-yi0xq where "sp2" is the hostname_prefix. + */ + hostname?: string | null; + /** + * Optional. Prefix for VM cluster host names. + */ + hostnamePrefix?: string | null; + /** + * Required. License type of VM Cluster. + */ + licenseType?: string | null; + /** + * Optional. Use local backup. + */ + localBackupEnabled?: boolean | null; + /** + * Optional. Memory allocated in GBs. + */ + memorySizeGb?: number | null; + /** + * Optional. Number of database servers. + */ + nodeCount?: number | null; + /** + * Output only. Oracle Cloud Infrastructure ID of VM Cluster. + */ + ocid?: string | null; + /** + * Output only. Deep link to the OCI console to view this resource. + */ + ociUrl?: string | null; + /** + * Optional. OCPU count per VM. Minimum is 0.1. + */ + ocpuCount?: number | null; + /** + * Output only. SCAN DNS name. ex: sp2-yi0xq-scan.ocispdelegated.ocisp10jvnet.oraclevcn.com + */ + scanDns?: string | null; + /** + * Output only. OCID of scan DNS record. + */ + scanDnsRecordId?: string | null; + /** + * Output only. OCIDs of scan IPs. + */ + scanIpIds?: string[] | null; + /** + * Output only. SCAN listener port - TCP + */ + scanListenerPortTcp?: number | null; + /** + * Output only. SCAN listener port - TLS + */ + scanListenerPortTcpSsl?: number | null; + /** + * Output only. Shape of VM Cluster. + */ + shape?: string | null; + /** + * Optional. Use exadata sparse snapshots. + */ + sparseDiskgroupEnabled?: boolean | null; + /** + * Optional. SSH public keys to be stored with cluster. + */ + sshPublicKeys?: string[] | null; + /** + * Output only. State of the cluster. + */ + state?: string | null; + /** + * Output only. The storage allocation for the disk group, in gigabytes (GB). + */ + storageSizeGb?: number | null; + /** + * Output only. Operating system version of the image. + */ + systemVersion?: string | null; + /** + * Optional. Time zone of VM Cluster to set. Defaults to UTC if not specified. + */ + timeZone?: Schema$TimeZone; + } + /** + * The CustomerContact reference as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/CustomerContact + */ + export interface Schema$CustomerContact { + /** + * Required. The email address used by Oracle to send notifications regarding databases and infrastructure. + */ + email?: string | null; + } + /** + * The connection string profile to allow clients to group. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/DatabaseConnectionStringProfile + */ + export interface Schema$DatabaseConnectionStringProfile { + /** + * Output only. The current consumer group being used by the connection. + */ + consumerGroup?: string | null; + /** + * Output only. The display name for the database connection. + */ + displayName?: string | null; + /** + * Output only. The host name format being currently used in connection string. + */ + hostFormat?: string | null; + /** + * Output only. This field indicates if the connection string is regional and is only applicable for cross-region Data Guard. + */ + isRegional?: boolean | null; + /** + * Output only. The protocol being used by the connection. + */ + protocol?: string | null; + /** + * Output only. The current session mode of the connection. + */ + sessionMode?: string | null; + /** + * Output only. The syntax of the connection string. + */ + syntaxFormat?: string | null; + /** + * Output only. This field indicates the TLS authentication type of the connection. + */ + tlsAuthentication?: string | null; + /** + * Output only. The value of the connection string. + */ + value?: string | null; + } + /** + * Data collection options for diagnostics. + */ + export interface Schema$DataCollectionOptions { + /** + * Optional. Indicates whether diagnostic collection is enabled for the VM cluster + */ + diagnosticsEventsEnabled?: boolean | null; + /** + * Optional. Indicates whether health monitoring is enabled for the VM cluster + */ + healthMonitoringEnabled?: boolean | null; + /** + * Optional. Indicates whether incident logs and trace collection are enabled for the VM cluster + */ + incidentLogsEnabled?: boolean | null; + } + /** + * Details of the database node resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbNode/ + */ + export interface Schema$DbNode { + /** + * Identifier. The name of the database node resource in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}/dbNodes/{db_node\} + */ + name?: string | null; + /** + * Optional. Various properties of the database node. + */ + properties?: Schema$DbNodeProperties; + } + /** + * Various properties and settings associated with Db node. + */ + export interface Schema$DbNodeProperties { + /** + * Optional. Local storage per database node. + */ + dbNodeStorageSizeGb?: number | null; + /** + * Optional. Database server OCID. + */ + dbServerOcid?: string | null; + /** + * Optional. DNS + */ + hostname?: string | null; + /** + * Memory allocated in GBs. + */ + memorySizeGb?: number | null; + /** + * Output only. OCID of database node. + */ + ocid?: string | null; + /** + * Optional. OCPU count per database node. + */ + ocpuCount?: number | null; + /** + * Output only. State of the database node. + */ + state?: string | null; + /** + * Total CPU core count of the database node. + */ + totalCpuCoreCount?: number | null; + } + /** + * Details of the database server resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbServer/ + */ + export interface Schema$DbServer { + /** + * Optional. User friendly name for this resource. + */ + displayName?: string | null; + /** + * Identifier. The name of the database server resource with the format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}/dbServers/{db_server\} + */ + name?: string | null; + /** + * Optional. Various properties of the database server. + */ + properties?: Schema$DbServerProperties; + } + /** + * Various properties and settings associated with Exadata database server. + */ + export interface Schema$DbServerProperties { + /** + * Output only. OCID of database nodes associated with the database server. + */ + dbNodeIds?: string[] | null; + /** + * Optional. Local storage per VM. + */ + dbNodeStorageSizeGb?: number | null; + /** + * Optional. Maximum local storage per VM. + */ + maxDbNodeStorageSizeGb?: number | null; + /** + * Optional. Maximum memory allocated in GBs. + */ + maxMemorySizeGb?: number | null; + /** + * Optional. Maximum OCPU count per database. + */ + maxOcpuCount?: number | null; + /** + * Optional. Memory allocated in GBs. + */ + memorySizeGb?: number | null; + /** + * Output only. OCID of database server. + */ + ocid?: string | null; + /** + * Optional. OCPU count per database. + */ + ocpuCount?: number | null; + /** + * Output only. State of the database server. + */ + state?: string | null; + /** + * Optional. Vm count per database. + */ + vmCount?: number | null; + } + /** + * Details of the Database System Shapes resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystemShapeSummary/ + */ + export interface Schema$DbSystemShape { + /** + * Optional. Number of cores per node. + */ + availableCoreCountPerNode?: number | null; + /** + * Optional. Storage per storage server in terabytes. + */ + availableDataStorageTb?: number | null; + /** + * Optional. Memory per database server node in gigabytes. + */ + availableMemoryPerNodeGb?: number | null; + /** + * Optional. Maximum number of database servers. + */ + maxNodeCount?: number | null; + /** + * Optional. Maximum number of storage servers. + */ + maxStorageCount?: number | null; + /** + * Optional. Minimum core count per node. + */ + minCoreCountPerNode?: number | null; + /** + * Optional. Minimum node storage per database server in gigabytes. + */ + minDbNodeStoragePerNodeGb?: number | null; + /** + * Optional. Minimum memory per node in gigabytes. + */ + minMemoryPerNodeGb?: number | null; + /** + * Optional. Minimum number of database servers. + */ + minNodeCount?: number | null; + /** + * Optional. Minimum number of storage servers. + */ + minStorageCount?: number | null; + /** + * Identifier. The name of the Database System Shape resource with the format: projects/{project\}/locations/{region\}/dbSystemShapes/{db_system_shape\} + */ + name?: string | null; + /** + * Optional. shape + */ + shape?: 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 {} + /** + * Details of the Entitlement resource. + */ + export interface Schema$Entitlement { + /** + * Details of the OCI Cloud Account. + */ + cloudAccountDetails?: Schema$CloudAccountDetails; + /** + * Output only. Google Cloud Marketplace order ID (aka entitlement ID) + */ + entitlementId?: string | null; + /** + * Identifier. The name of the Entitlement resource with the format: projects/{project\}/locations/{region\}/entitlements/{entitlement\} + */ + name?: string | null; + /** + * Output only. Entitlement State. + */ + state?: string | null; + } + /** + * The request for `AutonomousDatabase.GenerateWallet`. + */ + export interface Schema$GenerateAutonomousDatabaseWalletRequest { + /** + * Optional. True when requesting regional connection strings in PDB connect info, applicable to cross-region Data Guard only. + */ + isRegional?: boolean | null; + /** + * Required. The password used to encrypt the keys inside the wallet. The password must be a minimum of 8 characters. + */ + password?: string | null; + /** + * Optional. The type of wallet generation for the Autonomous Database. The default value is SINGLE. + */ + type?: string | null; + } + /** + * The response for `AutonomousDatabase.GenerateWallet`. + */ + export interface Schema$GenerateAutonomousDatabaseWalletResponse { + /** + * Output only. The base64 encoded wallet files. + */ + archiveContent?: string | null; + } + /** + * Details of the Oracle Grid Infrastructure (GI) version resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/GiVersionSummary/ + */ + export interface Schema$GiVersion { + /** + * Identifier. The name of the Oracle Grid Infrastructure (GI) version resource with the format: projects/{project\}/locations/{region\}/giVersions/{gi_versions\} + */ + name?: string | null; + /** + * Optional. version + */ + version?: string | null; + } + /** + * The response for `AutonomousDatabaseBackup.List`. + */ + export interface Schema$ListAutonomousDatabaseBackupsResponse { + /** + * The list of Autonomous Database Backups. + */ + autonomousDatabaseBackups?: Schema$AutonomousDatabaseBackup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `AutonomousDatabaseCharacterSet.List`. + */ + export interface Schema$ListAutonomousDatabaseCharacterSetsResponse { + /** + * The list of Autonomous Database Character Sets. + */ + autonomousDatabaseCharacterSets?: Schema$AutonomousDatabaseCharacterSet[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `AutonomousDatabase.List`. + */ + export interface Schema$ListAutonomousDatabasesResponse { + /** + * The list of Autonomous Databases. + */ + autonomousDatabases?: Schema$AutonomousDatabase[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `AutonomousDbVersion.List`. + */ + export interface Schema$ListAutonomousDbVersionsResponse { + /** + * The list of Autonomous Database versions. + */ + autonomousDbVersions?: Schema$AutonomousDbVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `CloudExadataInfrastructures.list`. + */ + export interface Schema$ListCloudExadataInfrastructuresResponse { + /** + * The list of Exadata Infrastructures. + */ + cloudExadataInfrastructures?: Schema$CloudExadataInfrastructure[]; + /** + * A token for fetching next page of response. + */ + nextPageToken?: string | null; + } + /** + * The response for `CloudVmCluster.List`. + */ + export interface Schema$ListCloudVmClustersResponse { + /** + * The list of VM Clusters. + */ + cloudVmClusters?: Schema$CloudVmCluster[]; + /** + * A token to fetch the next page of results. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbNode.List`. + */ + export interface Schema$ListDbNodesResponse { + /** + * The list of DB Nodes + */ + dbNodes?: Schema$DbNode[]; + /** + * A token identifying a page of results the node should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbServer.List`. + */ + export interface Schema$ListDbServersResponse { + /** + * The list of database servers. + */ + dbServers?: Schema$DbServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `DbSystemShape.List`. + */ + export interface Schema$ListDbSystemShapesResponse { + /** + * The list of Database System shapes. + */ + dbSystemShapes?: Schema$DbSystemShape[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `Entitlement.List`. + */ + export interface Schema$ListEntitlementsResponse { + /** + * The list of Entitlements + */ + entitlements?: Schema$Entitlement[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response for `GiVersion.List`. + */ + export interface Schema$ListGiVersionsResponse { + /** + * The list of Oracle Grid Infrastructure (GI) versions. + */ + giVersions?: Schema$GiVersion[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * 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; + } + /** + * Metadata for a given Location. + */ + export interface Schema$LocationMetadata { + /** + * Output only. Google Cloud Platform Oracle zones in a location. + */ + gcpOracleZones?: string[] | null; + } + /** + * Maintenance window as defined by Oracle. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/MaintenanceWindow + */ + export interface Schema$MaintenanceWindow { + /** + * Optional. Determines the amount of time the system will wait before the start of each database server patching operation. Custom action timeout is in minutes and valid value is between 15 to 120 (inclusive). + */ + customActionTimeoutMins?: number | null; + /** + * Optional. Days during the week when maintenance should be performed. + */ + daysOfWeek?: string[] | null; + /** + * Optional. The window of hours during the day when maintenance should be performed. The window is a 4 hour slot. Valid values are: 0 - represents time slot 0:00 - 3:59 UTC 4 - represents time slot 4:00 - 7:59 UTC 8 - represents time slot 8:00 - 11:59 UTC 12 - represents time slot 12:00 - 15:59 UTC 16 - represents time slot 16:00 - 19:59 UTC 20 - represents time slot 20:00 - 23:59 UTC + */ + hoursOfDay?: number[] | null; + /** + * Optional. If true, enables the configuration of a custom action timeout (waiting period) between database server patching operations. + */ + isCustomActionTimeoutEnabled?: boolean | null; + /** + * Optional. Lead time window allows user to set a lead time to prepare for a down time. The lead time is in weeks and valid value is between 1 to 4. + */ + leadTimeWeek?: number | null; + /** + * Optional. Months during the year when maintenance should be performed. + */ + months?: string[] | null; + /** + * Optional. Cloud CloudExadataInfrastructure node patching method, either "ROLLING" or "NONROLLING". Default value is ROLLING. + */ + patchingMode?: string | null; + /** + * Optional. The maintenance window scheduling preference. + */ + preference?: string | null; + /** + * Optional. Weeks during the month when maintenance should be performed. Weeks start on the 1st, 8th, 15th, and 22nd days of the month, and have a duration of 7 days. Weeks start and end based on calendar dates, not days of the week. + */ + weeksOfMonth?: number[] | 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. An estimated percentage of the operation that has been completed at a given moment of time, between 0 and 100. + */ + percentComplete?: number | 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. The status of the operation. + */ + 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 request for `AutonomousDatabase.Restore`. + */ + export interface Schema$RestoreAutonomousDatabaseRequest { + /** + * Required. The time and date to restore the database to. + */ + restoreTime?: string | null; + } + /** + * Details of scheduled operation. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/datatypes/ScheduledOperationDetails + */ + export interface Schema$ScheduledOperationDetails { + /** + * Output only. Day of week. + */ + dayOfWeek?: string | null; + /** + * Output only. Auto start time. + */ + startTime?: Schema$TimeOfDay; + /** + * Output only. Auto stop time. + */ + stopTime?: Schema$TimeOfDay; + } + /** + * 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; + } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of hour of day. Must be from 0 to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + + 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; + autonomousDatabaseBackups: Resource$Projects$Locations$Autonomousdatabasebackups; + autonomousDatabaseCharacterSets: Resource$Projects$Locations$Autonomousdatabasecharactersets; + autonomousDatabases: Resource$Projects$Locations$Autonomousdatabases; + autonomousDbVersions: Resource$Projects$Locations$Autonomousdbversions; + cloudExadataInfrastructures: Resource$Projects$Locations$Cloudexadatainfrastructures; + cloudVmClusters: Resource$Projects$Locations$Cloudvmclusters; + dbSystemShapes: Resource$Projects$Locations$Dbsystemshapes; + entitlements: Resource$Projects$Locations$Entitlements; + giVersions: Resource$Projects$Locations$Giversions; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.autonomousDatabaseBackups = + new Resource$Projects$Locations$Autonomousdatabasebackups(this.context); + this.autonomousDatabaseCharacterSets = + new Resource$Projects$Locations$Autonomousdatabasecharactersets( + this.context + ); + this.autonomousDatabases = + new Resource$Projects$Locations$Autonomousdatabases(this.context); + this.autonomousDbVersions = + new Resource$Projects$Locations$Autonomousdbversions(this.context); + this.cloudExadataInfrastructures = + new Resource$Projects$Locations$Cloudexadatainfrastructures( + this.context + ); + this.cloudVmClusters = new Resource$Projects$Locations$Cloudvmclusters( + this.context + ); + this.dbSystemShapes = new Resource$Projects$Locations$Dbsystemshapes( + this.context + ); + this.entitlements = new Resource$Projects$Locations$Entitlements( + this.context + ); + this.giVersions = new Resource$Projects$Locations$Giversions( + 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://oracledatabase.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://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabasebackups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the long-term and automatic backups of an Autonomous Database. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasebackups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasebackups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasebackups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabaseBackups').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$Autonomousdatabasebackups$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **autonomous_database_id** field is supported in the following format: `autonomous_database_id="{autonomous_database_id\}"`. The accepted values must be a valid Autonomous Database ID, limited to the naming restrictions of the ID: ^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$). The ID must start with a letter, end with a letter or a number, and be a maximum of 63 characters. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Backups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for ListAutonomousDatabaseBackups in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabasecharactersets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists Autonomous Database Character Sets 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$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabasecharactersets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/autonomousDatabaseCharacterSets' + ).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$Autonomousdatabasecharactersets$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. Only the **character_set_type** field is supported in the following format: `character_set_type="{characterSetType\}"`. Accepted values include `DATABASE` and `NATIONAL`. + */ + filter?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Character Sets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Autonomousdatabases { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Autonomous Database 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$Autonomousdatabases$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').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 Autonomous 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. + */ + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Delete; + 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}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates a wallet for an Autonomous 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. + */ + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions + ): GaxiosPromise; + generateWallet( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options?: MethodOptions + ): GaxiosPromise; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateWallet( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet, + callback: BodyResponseCallback + ): void; + generateWallet( + callback: BodyResponseCallback + ): void; + generateWallet( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Generatewallet; + 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}:generateWallet').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 details of a single Autonomous 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. + */ + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Get; + 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}').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 Autonomous Databases 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$Autonomousdatabases$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdatabases$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDatabases').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 + ); + } + } + + /** + * Restores a single Autonomous 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. + */ + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Autonomousdatabases$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdatabases$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdatabases$Restore; + 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}: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$Autonomousdatabases$Create + extends StandardParameters { + /** + * Required. The ID of the Autonomous Database to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + autonomousDatabaseId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$AutonomousDatabase; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Delete + extends StandardParameters { + /** + * Required. The name of the resource in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$Autonomousdatabases$Generatewallet + 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$GenerateAutonomousDatabaseWalletRequest; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Get + extends StandardParameters { + /** + * Required. The name of the Autonomous Database in the following format: projects/{project\}/locations/{location\}/autonomousDatabases/{autonomous_database\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. An expression for ordering the results of the request. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous Database will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Autonomousdatabases$Restore + 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$RestoreAutonomousDatabaseRequest; + } + + export class Resource$Projects$Locations$Autonomousdbversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the available Autonomous Database versions for a project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Autonomousdbversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Autonomousdbversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Autonomousdbversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Autonomousdbversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/autonomousDbVersions').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$Autonomousdbversions$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Autonomous DB Versions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the Autonomous Database in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures { + context: APIRequestContext; + dbServers: Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers; + constructor(context: APIRequestContext) { + this.context = context; + this.dbServers = + new Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers( + this.context + ); + } + + /** + * Creates a new Exadata Infrastructure 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$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).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 Exadata Infrastructure. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete; + 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}').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 Exadata Infrastructure. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Get; + 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}').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 Exadata Infrastructures 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$Cloudexadatainfrastructures$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/cloudExadataInfrastructures' + ).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$Cloudexadatainfrastructures$Create + extends StandardParameters { + /** + * Required. The ID of the Exadata Infrastructure to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudExadataInfrastructureId?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$CloudExadataInfrastructure; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Delete + extends StandardParameters { + /** + * Optional. If set to true, all VM clusters for this Exadata Infrastructure will be deleted. An Exadata Infrastructure can only be deleted once all its VM clusters have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$Cloudexadatainfrastructures$Get + extends StandardParameters { + /** + * Required. The name of the Cloud Exadata Infrastructure in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloud_exadata_infrastructure\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudexadatainfrastructures$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 Exadata infrastructures will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for CloudExadataInfrastructure in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database servers of an Exadata Infrastructure 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$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudexadatainfrastructures$Dbservers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dbServers').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$Cloudexadatainfrastructures$Dbservers$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 db servers will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for database server in the following format: projects/{project\}/locations/{location\}/cloudExadataInfrastructures/{cloudExadataInfrastructure\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudvmclusters { + context: APIRequestContext; + dbNodes: Resource$Projects$Locations$Cloudvmclusters$Dbnodes; + constructor(context: APIRequestContext) { + this.context = context; + this.dbNodes = new Resource$Projects$Locations$Cloudvmclusters$Dbnodes( + this.context + ); + } + + /** + * Creates a new VM 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$Cloudvmclusters$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').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 VM 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$Cloudvmclusters$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Delete; + 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}').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 VM 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$Cloudvmclusters$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$Get; + 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}').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 VM 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$Cloudvmclusters$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudvmclusters$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cloudVmClusters').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$Cloudvmclusters$Create + extends StandardParameters { + /** + * Required. The ID of the VM Cluster to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61\}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number. + */ + cloudVmClusterId?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$CloudVmCluster; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$Delete + extends StandardParameters { + /** + * Optional. If set to true, all child resources for the VM Cluster will be deleted. A VM Cluster can only be deleted once all its child resources have been deleted. + */ + force?: boolean; + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + /** + * Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, 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$Cloudvmclusters$Get + extends StandardParameters { + /** + * Required. The name of the Cloud VM Cluster in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloud_vm_cluster\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudvmclusters$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the request. + */ + filter?: string; + /** + * Optional. The number of VM clusters to return. If unspecified, at most 50 VM clusters will be returned. The maximum value is 1,000. + */ + pageSize?: number; + /** + * Optional. A token identifying the page of results the server returns. + */ + pageToken?: string; + /** + * Required. The name of the parent in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Cloudvmclusters$Dbnodes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database nodes of a VM 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$Cloudvmclusters$Dbnodes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Cloudvmclusters$Dbnodes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dbNodes').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$Cloudvmclusters$Dbnodes$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 db nodes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the node should return. + */ + pageToken?: string; + /** + * Required. The parent value for database node in the following format: projects/{project\}/locations/{location\}/cloudVmClusters/{cloudVmCluster\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Dbsystemshapes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the database system shapes available for the 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$Dbsystemshapes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Dbsystemshapes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Dbsystemshapes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Dbsystemshapes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Dbsystemshapes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Dbsystemshapes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dbSystemShapes').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$Dbsystemshapes$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, at most 50 database system shapes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for Database System Shapes in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Entitlements { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the entitlements 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$Entitlements$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Entitlements$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entitlements$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entitlements$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Entitlements$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entitlements$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entitlements$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entitlements$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/entitlements').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$Entitlements$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 entitlements will be returned. The maximum value is 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for the entitlement in the following format: projects/{project\}/locations/{location\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Giversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists all the valid Oracle Grid Infrastructure (GI) versions for the 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$Giversions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Giversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Giversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Giversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Giversions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Giversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Giversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Giversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://oracledatabase.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/giVersions').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$Giversions$List + extends StandardParameters { + /** + * Optional. The maximum number of items to return. If unspecified, a maximum of 50 Oracle Grid Infrastructure (GI) versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The parent value for Grid Infrastructure Version in the following format: Format: projects/{project\}/locations/{location\}. + */ + 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://oracledatabase.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://oracledatabase.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://oracledatabase.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://oracledatabase.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/oracledatabase/webpack.config.js b/src/apis/oracledatabase/webpack.config.js new file mode 100644 index 0000000000..fb538a6238 --- /dev/null +++ b/src/apis/oracledatabase/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: 'Oracledatabase', + filename: 'oracledatabase.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/osconfig/v1.ts b/src/apis/osconfig/v1.ts index 6cf721f249..262ce9fa30 100644 --- a/src/apis/osconfig/v1.ts +++ b/src/apis/osconfig/v1.ts @@ -1784,19 +1784,19 @@ export namespace osconfig_v1 { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts index 9303826c49..539a386625 100644 --- a/src/apis/osconfig/v1beta.ts +++ b/src/apis/osconfig/v1beta.ts @@ -1189,19 +1189,19 @@ export namespace osconfig_v1beta { */ export interface Schema$TimeOfDay { /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + * Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */ hours?: number | null; /** - * Minutes of hour of day. Must be from 0 to 59. + * Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */ minutes?: number | null; /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + * Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */ nanos?: number | null; /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + * Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */ seconds?: number | null; } diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 52f304a378..5e6de88ce9 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -1028,6 +1028,15 @@ export namespace places_v1 { */ name?: string | null; } + /** + * A route polyline. Only supports an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), which can be passed as a string and includes compression with minimal lossiness. This is the Routes API default output. + */ + export interface Schema$GoogleMapsPlacesV1Polyline { + /** + * An [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm), as returned by the [Routes API by default](https://developers.google.com/maps/documentation/routes/reference/rest/v2/TopLevel/computeRoutes#polylineencoding). See the [encoder](https://developers.google.com/maps/documentation/utilities/polylineutility) and [decoder](https://developers.google.com/maps/documentation/routes/polylinedecoder) tools. + */ + encodedPolyline?: string | null; + } /** * 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. */ @@ -1074,6 +1083,70 @@ export namespace places_v1 { */ text?: Schema$GoogleTypeLocalizedText; } + /** + * Encapsulates a set of optional conditions to satisfy when calculating the routes. + */ + export interface Schema$GoogleMapsPlacesV1RouteModifiers { + /** + * Optional. When set to true, avoids ferries where reasonable, giving preference to routes not containing ferries. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + */ + avoidFerries?: boolean | null; + /** + * Optional. When set to true, avoids highways where reasonable, giving preference to routes not containing highways. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + */ + avoidHighways?: boolean | null; + /** + * Optional. When set to true, avoids navigating indoors where reasonable, giving preference to routes not containing indoor navigation. Applies only to the `WALK` `TravelMode`. + */ + avoidIndoor?: boolean | null; + /** + * Optional. When set to true, avoids toll roads where reasonable, giving preference to routes not containing toll roads. Applies only to the `DRIVE` and `TWO_WHEELER` `TravelMode`. + */ + avoidTolls?: boolean | null; + } + /** + * Parameters to configure the routing calculations to the places in the response, both along a route (where result ranking will be influenced) and for calculating travel times on results. + */ + export interface Schema$GoogleMapsPlacesV1RoutingParameters { + /** + * Optional. An explicit routing origin that overrides the origin defined in the polyline. By default, the polyline origin is used. + */ + origin?: Schema$GoogleTypeLatLng; + /** + * Optional. The route modifiers. + */ + routeModifiers?: Schema$GoogleMapsPlacesV1RouteModifiers; + /** + * Optional. Specifies how to compute the routing summaries. The server attempts to use the selected routing preference to compute the route. The traffic aware routing preference is only available for the `DRIVE` or `TWO_WHEELER` `travelMode`. + */ + routingPreference?: string | null; + /** + * Optional. The travel mode. + */ + travelMode?: string | null; + } + /** + * The duration and distance from the routing origin to a place in the response, and a second leg from that place to the destination, if requested. **Note:** Adding `routingSummaries` in the field mask without also including either the `routingParameters.origin` parameter or the `searchAlongRouteParameters.polyline.encodedPolyline` parameter in the request causes an error. + */ + export interface Schema$GoogleMapsPlacesV1RoutingSummary { + /** + * The legs of the trip. When you calculate travel duration and distance from a set origin, `legs` contains a single leg containing the duration and distance from the origin to the destination. When you do a search along route, `legs` contains two legs: one from the origin to place, and one from the place to the destination. + */ + legs?: Schema$GoogleMapsPlacesV1RoutingSummaryLeg[]; + } + /** + * A leg is a single portion of a journey from one location to another. + */ + export interface Schema$GoogleMapsPlacesV1RoutingSummaryLeg { + /** + * The distance of this leg of the trip. + */ + distanceMeters?: number | null; + /** + * The time it takes to complete this leg of the trip. + */ + duration?: string | null; + } /** * Request proto for Search Nearby. */ @@ -1114,6 +1187,10 @@ export namespace places_v1 { * The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. */ regionCode?: string | null; + /** + * Optional. Parameters that affect the routing to the search results. + */ + routingParameters?: Schema$GoogleMapsPlacesV1RoutingParameters; } /** * The region to search. @@ -1132,6 +1209,10 @@ export namespace places_v1 { * A list of places that meets user's requirements like places types, number of places and specific location restriction. */ places?: Schema$GoogleMapsPlacesV1Place[]; + /** + * A list of routing summaries where each entry associates to the corresponding place in the same index in the `places` field. If the routing summary is not available for one of the places, it will contain an empty entry. This list should have as many entries as the list of places if requested. + */ + routingSummaries?: Schema$GoogleMapsPlacesV1RoutingSummary[]; } /** * Request proto for SearchText. @@ -1189,6 +1270,14 @@ export namespace places_v1 { * The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law. For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html. Note that 3-digit region codes are not currently supported. */ regionCode?: string | null; + /** + * Optional. Additional parameters for routing to results. + */ + routingParameters?: Schema$GoogleMapsPlacesV1RoutingParameters; + /** + * Optional. Additional parameters proto for searching along a route. + */ + searchAlongRouteParameters?: Schema$GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters; /** * Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false. */ @@ -1233,6 +1322,15 @@ export namespace places_v1 { */ rectangle?: Schema$GoogleGeoTypeViewport; } + /** + * Specifies a precalculated polyline from the [Routes API](https://developers.google.com/maps/documentation/routes) defining the route to search. Searching along a route is similar to using the `locationBias` or `locationRestriction` request option to bias the search results. However, while the `locationBias` and `locationRestriction` options let you specify a region to bias the search results, this option lets you bias the results along a trip route. Results are not guaranteed to be along the route provided, but rather are ranked within the search area defined by the polyline and, optionally, by the `locationBias` or `locationRestriction` based on minimal detour times from origin to destination. The results might be along an alternate route, especially if the provided polyline does not define an optimal route from origin to destination. + */ + export interface Schema$GoogleMapsPlacesV1SearchTextRequestSearchAlongRouteParameters { + /** + * Required. The route polyline. + */ + polyline?: Schema$GoogleMapsPlacesV1Polyline; + } /** * Response proto for SearchText. */ @@ -1249,6 +1347,10 @@ export namespace places_v1 { * A list of places that meet the user's text search criteria. */ places?: Schema$GoogleMapsPlacesV1Place[]; + /** + * A list of routing summaries where each entry associates to the corresponding place in the same index in the `places` field. If the routing summary is not available for one of the places, it will contain an empty entry. This list will have as many entries as the list of places if requested. + */ + routingSummaries?: Schema$GoogleMapsPlacesV1RoutingSummary[]; } /** * 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 diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index ff32490d47..7bb6790bdf 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -2357,7 +2357,7 @@ export namespace playdeveloperreporting_v1alpha1 { export interface Params$Resource$Vitals$Errors$Reports$Search extends StandardParameters { /** - * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` + * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` */ filter?: string; /** diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index a43b428715..e3c66fa9f3 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -2357,7 +2357,7 @@ export namespace playdeveloperreporting_v1beta1 { export interface Params$Resource$Vitals$Errors$Reports$Search extends StandardParameters { /** - * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `JAVA_CRASH`, `NATIVE_CRASH`, `ANR`. Example: `errorIssueType = JAVA_CRASH OR errorIssueType = NATIVE_CRASH`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` + * A selection predicate to retrieve only a subset of the reports. For filtering basics, please check [AIP-160](https://google.aip.dev/160). ** Supported field names:** * `apiLevel`: Matches error reports that occurred in the requested Android versions (specified as the numeric API level) only. Example: `apiLevel = 28 OR apiLevel = 29`. * `versionCode`: Matches error reports that occurred in the requested app version codes only. Example: `versionCode = 123 OR versionCode = 456`. * `deviceModel`: Matches error issues that occurred in the requested devices. Example: `deviceModel = "google/walleye" OR deviceModel = "google/marlin"`. * `deviceBrand`: Matches error issues that occurred in the requested device brands. Example: `deviceBrand = "Google". * `deviceType`: Matches error reports that occurred in the requested device types. Example: `deviceType = "PHONE"`. * `errorIssueType`: Matches error reports of the requested types only. Valid candidates: `CRASH`, `ANR`. Example: `errorIssueType = CRASH OR errorIssueType = ANR`. * `errorIssueId`: Matches error reports belonging to the requested error issue ids only. Example: `errorIssueId = 1234 OR errorIssueId = 4567`. * `errorReportId`: Matches error reports with the requested error report id. Example: `errorReportId = 1234 OR errorReportId = 4567`. * `appProcessState`: Matches error reports on the process state of an app, indicating whether an app runs in the foreground (user-visible) or background. Valid candidates: `FOREGROUND`, `BACKGROUND`. Example: `appProcessState = FOREGROUND`. * `isUserPerceived`: Matches error reports that are user-perceived. It is not accompanied by any operators. Example: `isUserPerceived`. ** Supported operators:** * Comparison operators: The only supported comparison operator is equality. The filtered field must appear on the left hand side of the comparison. * Logical Operators: Logical operators `AND` and `OR` can be used to build complex filters following a conjunctive normal form (CNF), i.e., conjunctions of disjunctions. The `OR` operator takes precedence over `AND` so the use of parenthesis is not necessary when building CNF. The `OR` operator is only supported to build disjunctions that apply to the same field, e.g., `versionCode = 123 OR versionCode = ANR`. The filter expression `versionCode = 123 OR errorIssueType = ANR` is not valid. ** Examples ** Some valid filtering expressions: * `versionCode = 123 AND errorIssueType = ANR` * `versionCode = 123 AND errorIssueType = OR errorIssueType = CRASH` * `versionCode = 123 AND (errorIssueType = OR errorIssueType = CRASH)` */ filter?: string; /** diff --git a/src/apis/privateca/v1.ts b/src/apis/privateca/v1.ts index fa2d2d52cb..0dc0046041 100644 --- a/src/apis/privateca/v1.ts +++ b/src/apis/privateca/v1.ts @@ -240,7 +240,7 @@ export namespace privateca_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The resource name for this CaPool in the format `projects/x/locations/x/caPools/x`. + * Output only. Identifier. The resource name for this CaPool in the format `projects/x/locations/x/caPools/x`. */ name?: string | null; /** @@ -2562,7 +2562,7 @@ export namespace privateca_v1 { export interface Params$Resource$Projects$Locations$Capools$Patch extends StandardParameters { /** - * Output only. The resource name for this CaPool in the format `projects/x/locations/x/caPools/x`. + * Output only. Identifier. The resource name for this CaPool in the format `projects/x/locations/x/caPools/x`. */ name?: string; /** diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 4809a8b99d..dd5527e15f 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -159,6 +159,10 @@ export namespace pubsub_v1 { */ writeMetadata?: boolean | null; } + /** + * Configuration for reading Cloud Storage data in Avro binary format. The bytes of each object will be set to the `data` field of a Pub/Sub message. + */ + export interface Schema$AvroFormat {} /** * Ingestion settings for Amazon Kinesis Data Streams. */ @@ -234,6 +238,39 @@ export namespace pubsub_v1 { */ role?: string | null; } + /** + * Ingestion settings for Cloud Storage. + */ + export interface Schema$CloudStorage { + /** + * Optional. Data from Cloud Storage will be interpreted in Avro format. + */ + avroFormat?: Schema$AvroFormat; + /** + * Optional. Cloud Storage bucket. The bucket name must be without any prefix like "gs://". See the [bucket naming requirements] (https://cloud.google.com/storage/docs/buckets#naming). + */ + bucket?: string | null; + /** + * Optional. Glob pattern used to match objects that will be ingested. If unset, all objects will be ingested. See the [supported patterns](https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob). + */ + matchGlob?: string | null; + /** + * Optional. Only objects with a larger or equal creation timestamp will be ingested. + */ + minimumObjectCreateTime?: string | null; + /** + * Optional. It will be assumed data from Cloud Storage was written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). + */ + pubsubAvroFormat?: Schema$PubSubAvroFormat; + /** + * Output only. An output-only field that indicates the state of the Cloud Storage ingestion source. + */ + state?: string | null; + /** + * Optional. Data from Cloud Storage will be interpreted as text. + */ + textFormat?: Schema$TextFormat; + } /** * Configuration for a Cloud Storage subscription. */ @@ -364,6 +401,14 @@ export namespace pubsub_v1 { * Optional. Amazon Kinesis Data Streams. */ awsKinesis?: Schema$AwsKinesis; + /** + * Optional. Cloud Storage. + */ + cloudStorage?: Schema$CloudStorage; + /** + * Optional. Platform Logs settings. If unset, no Platform Logs will be generated. + */ + platformLogsSettings?: Schema$PlatformLogsSettings; } /** * Response for the `ListSchemaRevisions` method. @@ -513,6 +558,15 @@ export namespace pubsub_v1 { */ serviceAccountEmail?: string | null; } + /** + * Settings for Platform Logs produced by Pub/Sub. + */ + export interface Schema$PlatformLogsSettings { + /** + * Optional. The minimum severity level of Platform Logs that will be written. + */ + severity?: string | null; + } /** * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ @@ -548,6 +602,10 @@ export namespace pubsub_v1 { */ messageIds?: string[] | null; } + /** + * Configuration for reading Cloud Storage data written via [Cloud Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage). The data and attributes fields of the originally exported Pub/Sub message will be restored when publishing. + */ + export interface Schema$PubSubAvroFormat {} /** * A message that is published by publishers and consumed by subscribers. The message must contain either a non-empty data field or at least one attribute. Note that client libraries represent this object differently depending on the language. See the corresponding [client library documentation](https://cloud.google.com/pubsub/docs/reference/libraries) for more information. See [quotas and limits] (https://cloud.google.com/pubsub/quotas) for more information about message limits. */ @@ -805,7 +863,7 @@ export namespace pubsub_v1 { */ labels?: {[key: string]: string} | null; /** - * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. + * Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 31 days or less than 10 minutes. */ messageRetentionDuration?: string | null; /** @@ -859,6 +917,15 @@ export namespace pubsub_v1 { * Configuration for writing message data in text format. Message payloads will be written to files as raw text, separated by a newline. */ export interface Schema$TextConfig {} + /** + * Configuration for reading Cloud Storage data in text format. Each line of text as specified by the delimiter will be set to the `data` field of a Pub/Sub message. + */ + export interface Schema$TextFormat { + /** + * Optional. When unset, '\n' is used. + */ + delimiter?: string | null; + } /** * A topic resource. */ diff --git a/src/apis/realtimebidding/v1.ts b/src/apis/realtimebidding/v1.ts index c5ff18355c..a7a42ebc63 100644 --- a/src/apis/realtimebidding/v1.ts +++ b/src/apis/realtimebidding/v1.ts @@ -1185,11 +1185,11 @@ export namespace realtimebidding_v1 { */ videoMetadata?: Schema$VideoMetadata; /** - * The URL to fetch a video ad. + * The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0, 3.0 or 4.x standard. */ videoUrl?: string | null; /** - * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. + * The contents of a VAST document for a video ad. This document should conform to the VAST 2.0, 3.0, or 4.x standard. */ videoVastXml?: string | null; } diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 3fc412e5f5..9a98f40fd7 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -193,7 +193,7 @@ export namespace recaptchaenterprise_v1 { */ accountId?: string | null; /** - * Optional. The annotation that will be assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. + * Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. */ annotation?: string | null; /** @@ -351,7 +351,7 @@ export namespace recaptchaenterprise_v1 { */ express?: boolean | null; /** - * Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. + * Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy is evaluated and a suggested firewall action is returned in the response. */ firewallPolicyEvaluation?: boolean | null; /** @@ -416,23 +416,23 @@ export namespace recaptchaenterprise_v1 { */ allow?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction; /** - * This action will deny access to a given page. The user will get an HTTP error code. + * This action denies access to a given page. The user gets an HTTP error code. */ block?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction; /** - * This action will inject reCAPTCHA JavaScript code into the HTML page returned by the site backend. + * This action injects reCAPTCHA JavaScript code into the HTML page returned by the site backend. */ includeRecaptchaScript?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction; /** - * This action will redirect the request to a ReCaptcha interstitial to attach a token. + * This action redirects the request to a reCAPTCHA interstitial to attach a token. */ redirect?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction; /** - * This action will set a custom header but allow the request to continue to the customer backend. + * This action sets a custom header but allow the request to continue to the customer backend. */ setHeader?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction; /** - * This action will transparently serve a different page to an offending user. + * This action transparently serves a different page to an offending user. */ substitute?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction; } @@ -449,7 +449,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionIncludeRecaptchaScriptAction {} /** - * A redirect action returns a 307 (temporary redirect) response, pointing the user to a ReCaptcha interstitial page to attach a token. + * A redirect action returns a 307 (temporary redirect) response, pointing the user to a reCAPTCHA interstitial page to attach a token. */ export interface Schema$GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction {} /** @@ -504,11 +504,11 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1FirewallPolicyAssessment { /** - * Output only. If the processing of a policy config fails, an error will be populated and the firewall_policy will be left empty. + * Output only. If the processing of a policy config fails, an error is populated and the firewall_policy is left empty. */ error?: Schema$GoogleRpcStatus; /** - * Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the incoming request, the policy field will be left empty. + * Output only. The policy that matched the request. If more than one policy may match, this is the first match. If no policy matches the incoming request, the policy field is left empty. */ firewallPolicy?: Schema$GoogleCloudRecaptchaenterpriseV1FirewallPolicy; } @@ -608,7 +608,7 @@ export namespace recaptchaenterprise_v1 { */ allowedBundleIds?: string[] | null; /** - * Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app. + * Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA to get a better assessment of the integrity of your app. */ appleDeveloperId?: Schema$GoogleCloudRecaptchaenterpriseV1AppleDeveloperId; } @@ -740,7 +740,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1Metrics { /** - * Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. + * Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data. */ challengeMetrics?: Schema$GoogleCloudRecaptchaenterpriseV1ChallengeMetrics[]; /** @@ -748,7 +748,7 @@ export namespace recaptchaenterprise_v1 { */ name?: string | null; /** - * Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. + * Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. */ scoreMetrics?: Schema$GoogleCloudRecaptchaenterpriseV1ScoreMetrics[]; /** @@ -949,11 +949,11 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1TestingOptions { /** - * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. + * Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE. */ testingChallenge?: string | null; /** - * Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. + * Optional. All assessments for this Key return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive. */ testingScore?: number | null; } @@ -1220,7 +1220,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1WebKeySettings { /** - * Optional. If set to true, it means allowed_domains will not be enforced. + * Optional. If set to true, it means allowed_domains are not enforced. */ allowAllDomains?: boolean | null; /** @@ -1232,7 +1232,7 @@ export namespace recaptchaenterprise_v1 { */ allowedDomains?: string[] | null; /** - * Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. + * Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE and SCORE_AND_CHALLENGE. */ challengeSecurityPreference?: string | null; /** @@ -1502,7 +1502,7 @@ export namespace recaptchaenterprise_v1 { export interface Params$Resource$Projects$Assessments$Create extends StandardParameters { /** - * Required. The name of the project in which the assessment will be created, in the format `projects/{project\}`. + * Required. The name of the project in which the assessment is created, in the format `projects/{project\}`. */ parent?: string; @@ -2095,7 +2095,7 @@ export namespace recaptchaenterprise_v1 { export interface Params$Resource$Projects$Firewallpolicies$Create extends StandardParameters { /** - * Required. The name of the project this policy will apply to, in the format `projects/{project\}`. + * Required. The name of the project this policy applies to, in the format `projects/{project\}`. */ parent?: string; @@ -2140,7 +2140,7 @@ export namespace recaptchaenterprise_v1 { */ name?: string; /** - * Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields will be updated. + * Optional. The mask to control which fields of the policy get updated. If the mask is not present, all fields are updated. */ updateMask?: string; @@ -2169,7 +2169,7 @@ export namespace recaptchaenterprise_v1 { } /** - * Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned. + * Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3027,7 +3027,7 @@ export namespace recaptchaenterprise_v1 { } /** - * Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error will be returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error will be returned. + * Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a `NOT_FOUND` error is returned. * If the IP is found in an existing IP override, but the override type does not match, a `NOT_FOUND` error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3238,7 +3238,7 @@ export namespace recaptchaenterprise_v1 { export interface Params$Resource$Projects$Keys$Create extends StandardParameters { /** - * Required. The name of the project in which the key will be created, in the format `projects/{project\}`. + * Required. The name of the project in which the key is created, in the format `projects/{project\}`. */ parent?: string; @@ -3279,7 +3279,7 @@ export namespace recaptchaenterprise_v1 { */ pageToken?: string; /** - * Required. The name of the project that contains the keys that will be listed, in the format `projects/{project\}`. + * Required. The name of the project that contains the keys that is listed, in the format `projects/{project\}`. */ parent?: string; } @@ -3317,7 +3317,7 @@ export namespace recaptchaenterprise_v1 { */ name?: string; /** - * Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated. + * Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields are updated. */ updateMask?: string; diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index 825b607200..81d04b4c56 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -133,6 +133,31 @@ export namespace redis_v1 { */ appendFsync?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * Configuration for availability of database instance */ @@ -190,6 +215,12 @@ export namespace redis_v1 { */ status?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } export interface Schema$CertChain { /** * The certificates that form the CA chain, from leaf to root order. @@ -206,6 +237,13 @@ export namespace redis_v1 { */ name?: string | null; } + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * A cluster instance. */ @@ -259,7 +297,7 @@ export namespace redis_v1 { */ pscConfigs?: Schema$PscConfig[]; /** - * Output only. PSC connections for discovery of the cluster topology and accessing the cluster. + * Output only. The list of PSC connections that are auto-created through service connectivity automation. */ pscConnections?: Schema$PscConnection[]; /** @@ -324,10 +362,6 @@ export namespace redis_v1 { * Output only. The end time of any upcoming scheduled maintenance for this instance. */ endTime?: string | null; - /** - * Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. - */ - scheduleDeadlineTime?: string | null; /** * Output only. The start time of any upcoming scheduled maintenance for this instance. */ @@ -358,10 +392,6 @@ export namespace redis_v1 { * Allows to define schedule that runs specified day of the week. */ day?: string | null; - /** - * Duration of the time window. - */ - duration?: string | null; /** * Start time of the window in UTC. */ @@ -515,7 +545,7 @@ export namespace redis_v1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. + * Common model for database resource instance metadata. Next ID: 23 */ export interface Schema$DatabaseResourceMetadata { /** @@ -542,6 +572,10 @@ export namespace redis_v1 { * Any custom metadata associated with the resource */ customMetadata?: Schema$CustomMetadataData; + /** + * Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance. + */ + edition?: string | null; /** * Entitlements associated with the resource */ @@ -570,6 +604,10 @@ export namespace redis_v1 { * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$DatabaseResourceId; + /** + * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceLocation?: string | null; /** * The product this resource represents. */ @@ -582,6 +620,10 @@ export namespace redis_v1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Tags associated with this resources. + */ + tagsSet?: Schema$Tags; /** * The time at which the resource was updated and recorded at partner service. */ @@ -628,6 +670,9 @@ export namespace redis_v1 { */ signalType?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -671,6 +716,15 @@ export namespace redis_v1 { */ outputConfig?: Schema$OutputConfig; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Request for Failover. */ @@ -945,6 +999,25 @@ export namespace redis_v1 { */ resourceName?: string | null; } + export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response for ListClusters. */ @@ -1030,6 +1103,18 @@ export namespace redis_v1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * MachineConfiguration describes the configuration of a machine specific to Database Resource. */ @@ -1042,6 +1127,10 @@ export namespace redis_v1 { * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; + /** + * Optional. Number of shards (if applicable). + */ + shardCount?: number | null; } /** * Maintenance policy for an instance. @@ -1241,6 +1330,15 @@ export namespace redis_v1 { */ rdbSnapshotStartTime?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * Product specification for Condor resources. */ @@ -1269,25 +1367,29 @@ export namespace redis_v1 { */ export interface Schema$PscConnection { /** - * Output only. The IP allocated on the consumer network for the PSC forwarding rule. + * Required. The IP allocated on the consumer network for the PSC forwarding rule. */ address?: string | null; /** - * Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId\}/regions/us-east1/forwardingRules/{resourceId\}. + * Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId\}/regions/us-east1/forwardingRules/{resourceId\}. */ forwardingRule?: string | null; /** - * The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. + * Required. The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. */ network?: string | null; /** - * Output only. The consumer project_id where the forwarding rule is created from. + * Optional. Project ID of the consumer project where the forwarding rule is created in. */ projectId?: string | null; /** - * Output only. The PSC connection id of the forwarding rule connected to the service attachment. + * Required. The PSC connection id of the forwarding rule connected to the service attachment. */ pscConnectionId?: string | null; + /** + * Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id\}/regions/{region\}/serviceAttachments/{service-attachment-id\}. + */ + serviceAttachment?: string | null; } /** * Configuration of the RDB based persistence. @@ -1315,6 +1417,19 @@ export namespace redis_v1 { */ exclusiveAction?: string | null; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Details of the remote cluster associated with this cluster in a cross cluster replication setup. */ @@ -1328,6 +1443,10 @@ export namespace redis_v1 { */ uid?: string | null; } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } /** * Request for rescheduling a cluster maintenance. */ @@ -1355,6 +1474,10 @@ export namespace redis_v1 { scheduleTime?: string | null; } export interface Schema$RetentionSettings { + /** + * Duration based retention period i.e. 172800 seconds (2 days) + */ + durationBasedRetention?: string | null; quantityBasedRetention?: number | null; /** * The unit that 'retained_backups' represents. @@ -1362,6 +1485,16 @@ export namespace redis_v1 { retentionUnit?: string | null; timeBasedRetention?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * Represents additional information about the state of the cluster. */ @@ -1388,6 +1521,18 @@ export namespace redis_v1 { */ message?: string | null; } + /** + * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. + */ + export interface Schema$Tags { + /** + * The Tag key/value mappings. + */ + tags?: {[key: string]: string} | null; + } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ @@ -1500,6 +1645,9 @@ export namespace redis_v1 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } /** * Zone distribution config for allocation of cluster resources. */ diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index f045876f7a..caf9728c54 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -133,6 +133,31 @@ export namespace redis_v1beta1 { */ appendFsync?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * Configuration for availability of database instance */ @@ -190,6 +215,12 @@ export namespace redis_v1beta1 { */ status?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } export interface Schema$CertChain { /** * The certificates that form the CA chain, from leaf to root order. @@ -206,6 +237,13 @@ export namespace redis_v1beta1 { */ name?: string | null; } + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * A cluster instance. */ @@ -259,7 +297,7 @@ export namespace redis_v1beta1 { */ pscConfigs?: Schema$PscConfig[]; /** - * Output only. PSC connections for discovery of the cluster topology and accessing the cluster. + * Output only. The list of PSC connections that are auto-created through service connectivity automation. */ pscConnections?: Schema$PscConnection[]; /** @@ -324,10 +362,6 @@ export namespace redis_v1beta1 { * Output only. The end time of any upcoming scheduled maintenance for this instance. */ endTime?: string | null; - /** - * Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule. - */ - scheduleDeadlineTime?: string | null; /** * Output only. The start time of any upcoming scheduled maintenance for this instance. */ @@ -358,10 +392,6 @@ export namespace redis_v1beta1 { * Allows to define schedule that runs specified day of the week. */ day?: string | null; - /** - * Duration of the time window. - */ - duration?: string | null; /** * Start time of the window in UTC. */ @@ -515,7 +545,7 @@ export namespace redis_v1beta1 { uniqueId?: string | null; } /** - * Common model for database resource instance metadata. + * Common model for database resource instance metadata. Next ID: 23 */ export interface Schema$DatabaseResourceMetadata { /** @@ -542,6 +572,10 @@ export namespace redis_v1beta1 { * Any custom metadata associated with the resource */ customMetadata?: Schema$CustomMetadataData; + /** + * Optional. Edition represents whether the instance is ENTERPRISE or ENTERPRISE_PLUS. This information is core to Cloud SQL only and is used to identify the edition of the instance. + */ + edition?: string | null; /** * Entitlements associated with the resource */ @@ -570,6 +604,10 @@ export namespace redis_v1beta1 { * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. */ primaryResourceId?: Schema$DatabaseResourceId; + /** + * Primary resource location. REQUIRED if the immediate parent exists when first time resource is getting ingested, otherwise optional. + */ + primaryResourceLocation?: string | null; /** * The product this resource represents. */ @@ -582,6 +620,10 @@ export namespace redis_v1beta1 { * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; + /** + * Optional. Tags associated with this resources. + */ + tagsSet?: Schema$Tags; /** * The time at which the resource was updated and recorded at partner service. */ @@ -628,6 +670,9 @@ export namespace redis_v1beta1 { */ signalType?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * Endpoints on each network, for Redis clients to connect to the cluster. */ @@ -671,6 +716,15 @@ export namespace redis_v1beta1 { */ outputConfig?: Schema$OutputConfig; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Request for Failover. */ @@ -945,6 +999,25 @@ export namespace redis_v1beta1 { */ resourceName?: string | null; } + export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response for ListClusters. */ @@ -1030,6 +1103,18 @@ export namespace redis_v1beta1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * MachineConfiguration describes the configuration of a machine specific to Database Resource. */ @@ -1042,6 +1127,10 @@ export namespace redis_v1beta1 { * Memory size in bytes. TODO(b/342344482, b/342346271) add proto validations again after bug fix. */ memorySizeInBytes?: string | null; + /** + * Optional. Number of shards (if applicable). + */ + shardCount?: number | null; } /** * Maintenance policy for an instance. @@ -1241,6 +1330,15 @@ export namespace redis_v1beta1 { */ rdbSnapshotStartTime?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * Product specification for Condor resources. */ @@ -1269,25 +1367,29 @@ export namespace redis_v1beta1 { */ export interface Schema$PscConnection { /** - * Output only. The IP allocated on the consumer network for the PSC forwarding rule. + * Required. The IP allocated on the consumer network for the PSC forwarding rule. */ address?: string | null; /** - * Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId\}/regions/us-east1/forwardingRules/{resourceId\}. + * Required. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId\}/regions/us-east1/forwardingRules/{resourceId\}. */ forwardingRule?: string | null; /** - * The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. + * Required. The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. */ network?: string | null; /** - * Output only. The consumer project_id where the forwarding rule is created from. + * Optional. Project ID of the consumer project where the forwarding rule is created in. */ projectId?: string | null; /** - * Output only. The PSC connection id of the forwarding rule connected to the service attachment. + * Required. The PSC connection id of the forwarding rule connected to the service attachment. */ pscConnectionId?: string | null; + /** + * Required. The service attachment which is the target of the PSC connection, in the form of projects/{project-id\}/regions/{region\}/serviceAttachments/{service-attachment-id\}. + */ + serviceAttachment?: string | null; } /** * Configuration of the RDB based persistence. @@ -1315,6 +1417,19 @@ export namespace redis_v1beta1 { */ exclusiveAction?: string | null; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Details of the remote cluster associated with this cluster in a cross cluster replication setup. */ @@ -1328,6 +1443,10 @@ export namespace redis_v1beta1 { */ uid?: string | null; } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } /** * Request for rescheduling a cluster maintenance. */ @@ -1355,6 +1474,10 @@ export namespace redis_v1beta1 { scheduleTime?: string | null; } export interface Schema$RetentionSettings { + /** + * Duration based retention period i.e. 172800 seconds (2 days) + */ + durationBasedRetention?: string | null; quantityBasedRetention?: number | null; /** * The unit that 'retained_backups' represents. @@ -1362,6 +1485,16 @@ export namespace redis_v1beta1 { retentionUnit?: string | null; timeBasedRetention?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * Represents additional information about the state of the cluster. */ @@ -1388,6 +1521,18 @@ export namespace redis_v1beta1 { */ message?: string | null; } + /** + * Message type for storing tags. Tags provide a way to create annotations for resources, and in some cases conditionally allow or deny policies based on whether a resource has a specific tag. + */ + export interface Schema$Tags { + /** + * The Tag key/value mappings. + */ + tags?: {[key: string]: string} | null; + } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. */ @@ -1500,6 +1645,9 @@ export namespace redis_v1beta1 { */ startTime?: Schema$TimeOfDay; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } /** * Zone distribution config for allocation of cluster resources. */ diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index 9d79e85bb6..7214754415 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -911,6 +911,24 @@ export namespace retail_v2 { */ genders?: string[] | null; } + /** + * Request for BatchUpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest { + /** + * Required. The updates question configs. + */ + requests?: Schema$GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest[]; + } + /** + * Aggregated response for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsResponse { + /** + * Optional. The updates question configs. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2GenerativeQuestionConfig[]; + } /** * Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method. */ @@ -1858,6 +1876,56 @@ export namespace retail_v2 { */ inputUris?: string[] | null; } + /** + * Configuration for a single generated question. + */ + export interface Schema$GoogleCloudRetailV2GenerativeQuestionConfig { + /** + * Optional. Whether the question is asked at serving time. + */ + allowedInConversation?: boolean | null; + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Output only. Values that can be used to answer the question. + */ + exampleValues?: string[] | null; + /** + * Required. The facet to which the question is associated. + */ + facet?: string | null; + /** + * Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used. + */ + finalQuestion?: string | null; + /** + * Output only. The ratio of how often a question was asked. + */ + frequency?: number | null; + /** + * Output only. The LLM generated question. + */ + generatedQuestion?: string | null; + } + /** + * Configuration for overall generative question feature state. + */ + export interface Schema$GoogleCloudRetailV2GenerativeQuestionsFeatureConfig { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied. + */ + featureEnabled?: boolean | null; + /** + * Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive. + */ + minimumProducts?: number | null; + } /** * Response message of CatalogService.GetDefaultBranch. */ @@ -2071,6 +2139,15 @@ export namespace retail_v2 { */ nextPageToken?: string | null; } + /** + * Response for ListQuestions method. + */ + export interface Schema$GoogleCloudRetailV2ListGenerativeQuestionConfigsResponse { + /** + * All the questions for a given catalog. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2GenerativeQuestionConfig[]; + } /** * Response to a ListModelRequest. */ @@ -2537,6 +2614,32 @@ export namespace retail_v2 { */ variants?: Schema$GoogleCloudRetailV2Product[]; } + /** + * Product attribute name and numeric interval. + */ + export interface Schema$GoogleCloudRetailV2ProductAttributeInterval { + /** + * The numeric interval (e.g. [10, 20)) + */ + interval?: Schema$GoogleCloudRetailV2Interval; + /** + * The attribute name (e.g. "length") + */ + name?: string | null; + } + /** + * Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. + */ + export interface Schema$GoogleCloudRetailV2ProductAttributeValue { + /** + * The attribute name. + */ + name?: string | null; + /** + * The attribute value. + */ + value?: string | null; + } /** * Detailed product information associated with a user event. */ @@ -3020,6 +3123,10 @@ export namespace retail_v2 { * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ canonicalFilter?: string | null; + /** + * Optional. This field specifies all conversational related parameters addition to traditional retail search. + */ + conversationalSearchSpec?: Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpec; /** * Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. */ @@ -3080,6 +3187,10 @@ export namespace retail_v2 { * The spell correction specification that specifies the mode under which spell correction will take effect. */ spellCorrectionSpec?: Schema$GoogleCloudRetailV2SearchRequestSpellCorrectionSpec; + /** + * Optional. This field specifies tile navigation related parameters. + */ + tileNavigationSpec?: Schema$GoogleCloudRetailV2SearchRequestTileNavigationSpec; /** * User information. */ @@ -3119,6 +3230,49 @@ export namespace retail_v2 { */ condition?: string | null; } + /** + * This field specifies all conversational related parameters addition to traditional retail search. + */ + export interface Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpec { + /** + * This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc. + */ + followupConversationRequested?: boolean | null; + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer; + } + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswer { + /** + * This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2SearchRequestConversationalSearchSpecUserAnswerSelectedAnswer { + /** + * This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + /** + * This field is deprecated and should not be set. + */ + productAttributeValues?: Schema$GoogleCloudRetailV2ProductAttributeValue[]; + } /** * The specifications of dynamically generated facets. */ @@ -3221,6 +3375,19 @@ export namespace retail_v2 { */ mode?: string | null; } + /** + * This field specifies tile navigation related parameters. + */ + export interface Schema$GoogleCloudRetailV2SearchRequestTileNavigationSpec { + /** + * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + */ + appliedTiles?: Schema$GoogleCloudRetailV2Tile[]; + /** + * This field specifies whether the customer would like to request tile navigation. + */ + tileNavigationRequested?: boolean | null; + } /** * Response message for SearchService.Search method. */ @@ -3233,6 +3400,10 @@ export namespace retail_v2 { * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */ attributionToken?: string | null; + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + conversationalSearchResult?: Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResult; /** * Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. */ @@ -3265,11 +3436,62 @@ export namespace retail_v2 { * A list of matched items. The order represents the ranking. */ results?: Schema$GoogleCloudRetailV2SearchResponseSearchResult[]; + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + tileNavigationResult?: Schema$GoogleCloudRetailV2SearchResponseTileNavigationResult; /** * The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */ totalSize?: number | null; } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request. + */ + additionalFilter?: Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter; + /** + * This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`. + */ + additionalFilters?: Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter[]; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The follow-up question. e.g., `What is the color?` + */ + followupQuestion?: string | null; + /** + * The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`. + */ + refinedQuery?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer[]; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + } + /** + * Suggested answers to the follow-up question. + */ + export interface Schema$GoogleCloudRetailV2SearchResponseConversationalSearchResultSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + } /** * A facet result. */ @@ -3354,6 +3576,15 @@ export namespace retail_v2 { */ variantRollupValues?: {[key: string]: any} | null; } + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + export interface Schema$GoogleCloudRetailV2SearchResponseTileNavigationResult { + /** + * The current tiles that are used for tile navigation, sorted by engagement. + */ + tiles?: Schema$GoogleCloudRetailV2Tile[]; + } /** * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). */ @@ -3485,6 +3716,23 @@ export namespace retail_v2 { * Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method. */ export interface Schema$GoogleCloudRetailV2SetInventoryResponse {} + /** + * This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. + */ + export interface Schema$GoogleCloudRetailV2Tile { + /** + * The product attribute key-numeric interval. + */ + productAttributeInterval?: Schema$GoogleCloudRetailV2ProductAttributeInterval; + /** + * The product attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2ProductAttributeValue; + /** + * The representative product id for this tile. + */ + representativeProductId?: string | null; + } /** * Metadata associated with a tune operation. */ @@ -3502,6 +3750,19 @@ export namespace retail_v2 { * Response associated with a tune operation. */ export interface Schema$GoogleCloudRetailV2TuneModelResponse {} + /** + * Request for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2UpdateGenerativeQuestionConfigRequest { + /** + * Required. The question to update. + */ + generativeQuestionConfig?: Schema$GoogleCloudRetailV2GenerativeQuestionConfig; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string | null; + } /** * UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. */ @@ -3760,6 +4021,8 @@ export namespace retail_v2 { branches: Resource$Projects$Locations$Catalogs$Branches; completionData: Resource$Projects$Locations$Catalogs$Completiondata; controls: Resource$Projects$Locations$Catalogs$Controls; + generativeQuestion: Resource$Projects$Locations$Catalogs$Generativequestion; + generativeQuestions: Resource$Projects$Locations$Catalogs$Generativequestions; models: Resource$Projects$Locations$Catalogs$Models; operations: Resource$Projects$Locations$Catalogs$Operations; placements: Resource$Projects$Locations$Catalogs$Placements; @@ -3777,6 +4040,14 @@ export namespace retail_v2 { this.controls = new Resource$Projects$Locations$Catalogs$Controls( this.context ); + this.generativeQuestion = + new Resource$Projects$Locations$Catalogs$Generativequestion( + this.context + ); + this.generativeQuestions = + new Resource$Projects$Locations$Catalogs$Generativequestions( + this.context + ); this.models = new Resource$Projects$Locations$Catalogs$Models( this.context ); @@ -4275,6 +4546,104 @@ export namespace retail_v2 { } } + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+catalog}/generativeQuestionFeature').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists all the Catalogs associated with the project. * @@ -4747,42 +5116,238 @@ export namespace retail_v2 { ); } } - } - export interface Params$Resource$Projects$Locations$Catalogs$Completequery - extends StandardParameters { - /** - * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. - */ - 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). - */ - dataset?: string; - /** - * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. - */ - deviceType?: string; - /** - * 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. - */ - entity?: string; - /** - * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. - */ - languageCodes?: string[]; - /** - * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. - */ - maxSuggestions?: number; /** - * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * Allows management of individual questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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?: string; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+catalog}/generativeQuestion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+catalog}/generativeQuestionFeature').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Completequery + extends StandardParameters { + /** + * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. + */ + 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). + */ + dataset?: string; + /** + * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. + */ + deviceType?: string; + /** + * 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. + */ + entity?: string; + /** + * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. + */ + languageCodes?: string[]; + /** + * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. + */ + maxSuggestions?: number; + /** + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + */ + query?: string; /** * Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ @@ -4821,6 +5386,13 @@ export namespace retail_v2 { */ catalog?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + } export interface Params$Resource$Projects$Locations$Catalogs$List extends StandardParameters { /** @@ -4896,6 +5468,38 @@ export namespace retail_v2 { */ requestBody?: Schema$GoogleCloudRetailV2CompletionConfig; } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + extends StandardParameters { + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2GenerativeQuestionConfig; + } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2GenerativeQuestionsFeatureConfig; + } export class Resource$Projects$Locations$Catalogs$Attributesconfig { context: APIRequestContext; @@ -7320,6 +7924,236 @@ export namespace retail_v2 { requestBody?: Schema$GoogleCloudRetailV2Control; } + export class Resource$Projects$Locations$Catalogs$Generativequestion { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Allows management of multiple questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2/{+parent}/generativeQuestion:batchUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + extends StandardParameters { + /** + * Optional. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2BatchUpdateGenerativeQuestionConfigsRequest; + } + + export class Resource$Projects$Locations$Catalogs$Generativequestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns all questions for a given catalog. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Catalogs$Generativequestions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/generativeQuestions').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$Catalogs$Generativequestions$List + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + } + export class Resource$Projects$Locations$Catalogs$Models { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 65cb27572b..d2f4e4f035 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -432,6 +432,24 @@ export namespace retail_v2alpha { */ resetCatalogAttributes?: string[] | null; } + /** + * Request for BatchUpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest { + /** + * Required. The updates question configs. + */ + requests?: Schema$GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest[]; + } + /** + * Aggregated response for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse { + /** + * Optional. The updates question configs. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2alphaGenerativeQuestionConfig[]; + } /** * A BigQuery output result. */ @@ -1149,6 +1167,56 @@ export namespace retail_v2alpha { */ inputUris?: string[] | null; } + /** + * Configuration for a single generated question. + */ + export interface Schema$GoogleCloudRetailV2alphaGenerativeQuestionConfig { + /** + * Optional. Whether the question is asked at serving time. + */ + allowedInConversation?: boolean | null; + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Output only. Values that can be used to answer the question. + */ + exampleValues?: string[] | null; + /** + * Required. The facet to which the question is associated. + */ + facet?: string | null; + /** + * Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used. + */ + finalQuestion?: string | null; + /** + * Output only. The ratio of how often a question was asked. + */ + frequency?: number | null; + /** + * Output only. The LLM generated question. + */ + generatedQuestion?: string | null; + } + /** + * Configuration for overall generative question feature state. + */ + export interface Schema$GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied. + */ + featureEnabled?: boolean | null; + /** + * Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive. + */ + minimumProducts?: number | null; + } /** * Response message of CatalogService.GetDefaultBranch. */ @@ -1388,6 +1456,15 @@ export namespace retail_v2alpha { */ enrolledSolutions?: string[] | null; } + /** + * Response for ListQuestions method. + */ + export interface Schema$GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse { + /** + * All the questions for a given catalog. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2alphaGenerativeQuestionConfig[]; + } /** * Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method. */ @@ -2066,6 +2143,32 @@ export namespace retail_v2alpha { */ variants?: Schema$GoogleCloudRetailV2alphaProduct[]; } + /** + * Product attribute name and numeric interval. + */ + export interface Schema$GoogleCloudRetailV2alphaProductAttributeInterval { + /** + * The numeric interval (e.g. [10, 20)) + */ + interval?: Schema$GoogleCloudRetailV2alphaInterval; + /** + * The attribute name (e.g. "length") + */ + name?: string | null; + } + /** + * Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. + */ + export interface Schema$GoogleCloudRetailV2alphaProductAttributeValue { + /** + * The attribute name. + */ + name?: string | null; + /** + * The attribute value. + */ + value?: string | null; + } /** * Detailed product information associated with a user event. */ @@ -2562,6 +2665,10 @@ export namespace retail_v2alpha { * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ canonicalFilter?: string | null; + /** + * Optional. This field specifies all conversational related parameters addition to traditional retail search. + */ + conversationalSearchSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec; /** * Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. */ @@ -2626,6 +2733,10 @@ export namespace retail_v2alpha { * The spell correction specification that specifies the mode under which spell correction will take effect. */ spellCorrectionSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec; + /** + * Optional. This field specifies tile navigation related parameters. + */ + tileNavigationSpec?: Schema$GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec; /** * User information. */ @@ -2665,6 +2776,49 @@ export namespace retail_v2alpha { */ condition?: string | null; } + /** + * This field specifies all conversational related parameters addition to traditional retail search. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec { + /** + * This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc. + */ + followupConversationRequested?: boolean | null; + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer; + } + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer { + /** + * This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer { + /** + * This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + /** + * This field is deprecated and should not be set. + */ + productAttributeValues?: Schema$GoogleCloudRetailV2alphaProductAttributeValue[]; + } /** * The specifications of dynamically generated facets. */ @@ -2767,6 +2921,19 @@ export namespace retail_v2alpha { */ mode?: string | null; } + /** + * This field specifies tile navigation related parameters. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec { + /** + * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + */ + appliedTiles?: Schema$GoogleCloudRetailV2alphaTile[]; + /** + * This field specifies whether the customer would like to request tile navigation. + */ + tileNavigationRequested?: boolean | null; + } /** * Response message for SearchService.Search method. */ @@ -2779,6 +2946,10 @@ export namespace retail_v2alpha { * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */ attributionToken?: string | null; + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + conversationalSearchResult?: Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult; /** * Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. */ @@ -2811,11 +2982,62 @@ export namespace retail_v2alpha { * A list of matched items. The order represents the ranking. */ results?: Schema$GoogleCloudRetailV2alphaSearchResponseSearchResult[]; + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + tileNavigationResult?: Schema$GoogleCloudRetailV2alphaSearchResponseTileNavigationResult; /** * The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */ totalSize?: number | null; } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request. + */ + additionalFilter?: Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter; + /** + * This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`. + */ + additionalFilters?: Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter[]; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The follow-up question. e.g., `What is the color?` + */ + followupQuestion?: string | null; + /** + * The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`. + */ + refinedQuery?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer[]; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + } + /** + * Suggested answers to the follow-up question. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + } /** * A facet result. */ @@ -2900,6 +3122,15 @@ export namespace retail_v2alpha { */ variantRollupValues?: {[key: string]: any} | null; } + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + export interface Schema$GoogleCloudRetailV2alphaSearchResponseTileNavigationResult { + /** + * The current tiles that are used for tile navigation, sorted by engagement. + */ + tiles?: Schema$GoogleCloudRetailV2alphaTile[]; + } /** * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). */ @@ -3031,6 +3262,23 @@ export namespace retail_v2alpha { * Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method. */ export interface Schema$GoogleCloudRetailV2alphaSetInventoryResponse {} + /** + * This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. + */ + export interface Schema$GoogleCloudRetailV2alphaTile { + /** + * The product attribute key-numeric interval. + */ + productAttributeInterval?: Schema$GoogleCloudRetailV2alphaProductAttributeInterval; + /** + * The product attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2alphaProductAttributeValue; + /** + * The representative product id for this tile. + */ + representativeProductId?: string | null; + } /** * Metadata related to transform user events operation. */ @@ -3061,6 +3309,19 @@ export namespace retail_v2alpha { * Response associated with a tune operation. */ export interface Schema$GoogleCloudRetailV2alphaTuneModelResponse {} + /** + * Request for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest { + /** + * Required. The question to update. + */ + generativeQuestionConfig?: Schema$GoogleCloudRetailV2alphaGenerativeQuestionConfig; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string | null; + } /** * UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. */ @@ -4830,6 +5091,8 @@ export namespace retail_v2alpha { branches: Resource$Projects$Locations$Catalogs$Branches; completionData: Resource$Projects$Locations$Catalogs$Completiondata; controls: Resource$Projects$Locations$Catalogs$Controls; + generativeQuestion: Resource$Projects$Locations$Catalogs$Generativequestion; + generativeQuestions: Resource$Projects$Locations$Catalogs$Generativequestions; merchantCenterAccountLinks: Resource$Projects$Locations$Catalogs$Merchantcenteraccountlinks; models: Resource$Projects$Locations$Catalogs$Models; operations: Resource$Projects$Locations$Catalogs$Operations; @@ -4848,6 +5111,14 @@ export namespace retail_v2alpha { this.controls = new Resource$Projects$Locations$Catalogs$Controls( this.context ); + this.generativeQuestion = + new Resource$Projects$Locations$Catalogs$Generativequestion( + this.context + ); + this.generativeQuestions = + new Resource$Projects$Locations$Catalogs$Generativequestions( + this.context + ); this.merchantCenterAccountLinks = new Resource$Projects$Locations$Catalogs$Merchantcenteraccountlinks( this.context @@ -5349,6 +5620,103 @@ export namespace retail_v2alpha { } } + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+catalog}/generativeQuestionFeature' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists all the Catalogs associated with the project. * @@ -5823,43 +6191,238 @@ export namespace retail_v2alpha { ); } } - } - export interface Params$Resource$Projects$Locations$Catalogs$Completequery - extends StandardParameters { - /** - * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. - */ - 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). - */ - dataset?: string; - /** - * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. - */ - deviceType?: string; - /** - * 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. - */ - entity?: string; - /** - * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. - */ - languageCodes?: string[]; - /** - * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. - */ - maxSuggestions?: number; - /** - * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * Allows management of individual questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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?: string; - /** + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+catalog}/generativeQuestion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+catalog}/generativeQuestionFeature' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Completequery + extends StandardParameters { + /** + * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. + */ + 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). + */ + dataset?: string; + /** + * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. + */ + deviceType?: string; + /** + * 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. + */ + entity?: string; + /** + * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. + */ + languageCodes?: string[]; + /** + * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. + */ + maxSuggestions?: number; + /** + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + */ + query?: string; + /** * Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ visitorId?: string; @@ -5897,6 +6460,13 @@ export namespace retail_v2alpha { */ catalog?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + } export interface Params$Resource$Projects$Locations$Catalogs$List extends StandardParameters { /** @@ -5972,6 +6542,38 @@ export namespace retail_v2alpha { */ requestBody?: Schema$GoogleCloudRetailV2alphaCompletionConfig; } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + extends StandardParameters { + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaGenerativeQuestionConfig; + } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig; + } export class Resource$Projects$Locations$Catalogs$Attributesconfig { context: APIRequestContext; @@ -8971,6 +9573,236 @@ export namespace retail_v2alpha { requestBody?: Schema$GoogleCloudRetailV2alphaControl; } + export class Resource$Projects$Locations$Catalogs$Generativequestion { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Allows management of multiple questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2alpha/{+parent}/generativeQuestion:batchUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + extends StandardParameters { + /** + * Optional. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest; + } + + export class Resource$Projects$Locations$Catalogs$Generativequestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns all questions for a given catalog. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Catalogs$Generativequestions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+parent}/generativeQuestions').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$Catalogs$Generativequestions$List + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + } + export class Resource$Projects$Locations$Catalogs$Merchantcenteraccountlinks { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 386dca5917..48db942a66 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -988,6 +988,24 @@ export namespace retail_v2beta { */ resetCatalogAttributes?: string[] | null; } + /** + * Request for BatchUpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest { + /** + * Required. The updates question configs. + */ + requests?: Schema$GoogleCloudRetailV2betaUpdateGenerativeQuestionConfigRequest[]; + } + /** + * Aggregated response for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsResponse { + /** + * Optional. The updates question configs. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2betaGenerativeQuestionConfig[]; + } /** * A BigQuery output result. */ @@ -1595,6 +1613,56 @@ export namespace retail_v2beta { */ inputUris?: string[] | null; } + /** + * Configuration for a single generated question. + */ + export interface Schema$GoogleCloudRetailV2betaGenerativeQuestionConfig { + /** + * Optional. Whether the question is asked at serving time. + */ + allowedInConversation?: boolean | null; + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Output only. Values that can be used to answer the question. + */ + exampleValues?: string[] | null; + /** + * Required. The facet to which the question is associated. + */ + facet?: string | null; + /** + * Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used. + */ + finalQuestion?: string | null; + /** + * Output only. The ratio of how often a question was asked. + */ + frequency?: number | null; + /** + * Output only. The LLM generated question. + */ + generatedQuestion?: string | null; + } + /** + * Configuration for overall generative question feature state. + */ + export interface Schema$GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string | null; + /** + * Optional. Determines whether questions will be used at serving time. Note: This feature cannot be enabled until initial data requirements are satisfied. + */ + featureEnabled?: boolean | null; + /** + * Optional. Minimum number of products in the response to trigger follow-up questions. Value must be 0 or positive. + */ + minimumProducts?: number | null; + } /** * Response message of CatalogService.GetDefaultBranch. */ @@ -1808,6 +1876,15 @@ export namespace retail_v2beta { */ nextPageToken?: string | null; } + /** + * Response for ListQuestions method. + */ + export interface Schema$GoogleCloudRetailV2betaListGenerativeQuestionConfigsResponse { + /** + * All the questions for a given catalog. + */ + generativeQuestionConfigs?: Schema$GoogleCloudRetailV2betaGenerativeQuestionConfig[]; + } /** * Response to a ListModelRequest. */ @@ -2325,6 +2402,32 @@ export namespace retail_v2beta { */ variants?: Schema$GoogleCloudRetailV2betaProduct[]; } + /** + * Product attribute name and numeric interval. + */ + export interface Schema$GoogleCloudRetailV2betaProductAttributeInterval { + /** + * The numeric interval (e.g. [10, 20)) + */ + interval?: Schema$GoogleCloudRetailV2betaInterval; + /** + * The attribute name (e.g. "length") + */ + name?: string | null; + } + /** + * Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have `name=color` and `value=red`, this means that the color is `red`. + */ + export interface Schema$GoogleCloudRetailV2betaProductAttributeValue { + /** + * The attribute name. + */ + name?: string | null; + /** + * The attribute value. + */ + value?: string | null; + } /** * Detailed product information associated with a user event. */ @@ -2808,6 +2911,10 @@ export namespace retail_v2beta { * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ canonicalFilter?: string | null; + /** + * Optional. This field specifies all conversational related parameters addition to traditional retail search. + */ + conversationalSearchSpec?: Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpec; /** * Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field. The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated. */ @@ -2868,6 +2975,10 @@ export namespace retail_v2beta { * The spell correction specification that specifies the mode under which spell correction will take effect. */ spellCorrectionSpec?: Schema$GoogleCloudRetailV2betaSearchRequestSpellCorrectionSpec; + /** + * Optional. This field specifies tile navigation related parameters. + */ + tileNavigationSpec?: Schema$GoogleCloudRetailV2betaSearchRequestTileNavigationSpec; /** * User information. */ @@ -2907,6 +3018,49 @@ export namespace retail_v2beta { */ condition?: string | null; } + /** + * This field specifies all conversational related parameters addition to traditional retail search. + */ + export interface Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpec { + /** + * This field specifies the conversation id, which maintains the state of the conversation between client side and server side. Use the value from the previous ConversationalSearchResult.conversation_id. For the initial request, this should be empty. + */ + conversationId?: string | null; + /** + * This field specifies whether the customer would like to do conversational search. If this field is set to true, conversational related extra information will be returned from server side, including follow-up question, answer options, etc. + */ + followupConversationRequested?: boolean | null; + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + userAnswer?: Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswer; + } + /** + * This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text. + */ + export interface Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswer { + /** + * This field specifies the selected attributes during the conversational search. This should be a subset of ConversationalSearchResult.suggested_answers. + */ + selectedAnswer?: Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer; + /** + * This field specifies the incremental input text from the user during the conversational search. + */ + textAnswer?: string | null; + } + /** + * This field specifies the selected answers during the conversational search. + */ + export interface Schema$GoogleCloudRetailV2betaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer { + /** + * This field specifies the selected answer which is a attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + /** + * This field is deprecated and should not be set. + */ + productAttributeValues?: Schema$GoogleCloudRetailV2betaProductAttributeValue[]; + } /** * The specifications of dynamically generated facets. */ @@ -3009,6 +3163,19 @@ export namespace retail_v2beta { */ mode?: string | null; } + /** + * This field specifies tile navigation related parameters. + */ + export interface Schema$GoogleCloudRetailV2betaSearchRequestTileNavigationSpec { + /** + * This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter. + */ + appliedTiles?: Schema$GoogleCloudRetailV2betaTile[]; + /** + * This field specifies whether the customer would like to request tile navigation. + */ + tileNavigationRequested?: boolean | null; + } /** * Response message for SearchService.Search method. */ @@ -3021,6 +3188,10 @@ export namespace retail_v2beta { * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */ attributionToken?: string | null; + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + conversationalSearchResult?: Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResult; /** * Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. */ @@ -3053,11 +3224,62 @@ export namespace retail_v2beta { * A list of matched items. The order represents the ranking. */ results?: Schema$GoogleCloudRetailV2betaSearchResponseSearchResult[]; + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + tileNavigationResult?: Schema$GoogleCloudRetailV2betaSearchResponseTileNavigationResult; /** * The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */ totalSize?: number | null; } + /** + * This field specifies all related information that is needed on client side for UI rendering of conversational retail search. + */ + export interface Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResult { + /** + * This is the incremental additional filters implied from the current user answer. User should add the suggested addition filters to the previous SearchRequest.filter, and use the merged filter in the follow up search request. + */ + additionalFilter?: Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter; + /** + * This field is deprecated but will be kept for backward compatibility. There is expected to have only one additional filter and the value will be the same to the same as field `additional_filter`. + */ + additionalFilters?: Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter[]; + /** + * Conversation UUID. This field will be stored in client side storage to maintain the conversation session with server and will be used for next search request's SearchRequest.ConversationalSearchSpec.conversation_id to restore conversation state in server. + */ + conversationId?: string | null; + /** + * The follow-up question. e.g., `What is the color?` + */ + followupQuestion?: string | null; + /** + * The current refined query for the conversational search. This field will be used in customer UI that the query in the search bar should be replaced with the refined query. For example, if SearchRequest.query is `dress` and next SearchRequest.ConversationalSearchSpec.UserAnswer.text_answer is `red color`, which does not match any product attribute value filters, the refined query will be `dress, red color`. + */ + refinedQuery?: string | null; + /** + * The answer options provided to client for the follow-up question. + */ + suggestedAnswers?: Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResultSuggestedAnswer[]; + } + /** + * Additional filter that client side need to apply. + */ + export interface Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResultAdditionalFilter { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + } + /** + * Suggested answers to the follow-up question. + */ + export interface Schema$GoogleCloudRetailV2betaSearchResponseConversationalSearchResultSuggestedAnswer { + /** + * Product attribute value, including an attribute key and an attribute value. Other types can be added here in the future. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + } /** * A facet result. */ @@ -3142,6 +3364,15 @@ export namespace retail_v2beta { */ variantRollupValues?: {[key: string]: any} | null; } + /** + * This field specifies all related information for tile navigation that will be used in client side. + */ + export interface Schema$GoogleCloudRetailV2betaSearchResponseTileNavigationResult { + /** + * The current tiles that are used for tile navigation, sorted by engagement. + */ + tiles?: Schema$GoogleCloudRetailV2betaTile[]; + } /** * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). */ @@ -3273,6 +3504,23 @@ export namespace retail_v2beta { * Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method. */ export interface Schema$GoogleCloudRetailV2betaSetInventoryResponse {} + /** + * This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc. + */ + export interface Schema$GoogleCloudRetailV2betaTile { + /** + * The product attribute key-numeric interval. + */ + productAttributeInterval?: Schema$GoogleCloudRetailV2betaProductAttributeInterval; + /** + * The product attribute key-value. + */ + productAttributeValue?: Schema$GoogleCloudRetailV2betaProductAttributeValue; + /** + * The representative product id for this tile. + */ + representativeProductId?: string | null; + } /** * Metadata associated with a tune operation. */ @@ -3290,6 +3538,19 @@ export namespace retail_v2beta { * Response associated with a tune operation. */ export interface Schema$GoogleCloudRetailV2betaTuneModelResponse {} + /** + * Request for UpdateGenerativeQuestionConfig method. + */ + export interface Schema$GoogleCloudRetailV2betaUpdateGenerativeQuestionConfigRequest { + /** + * Required. The question to update. + */ + generativeQuestionConfig?: Schema$GoogleCloudRetailV2betaGenerativeQuestionConfig; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string | null; + } /** * UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. */ @@ -4122,6 +4383,8 @@ export namespace retail_v2beta { branches: Resource$Projects$Locations$Catalogs$Branches; completionData: Resource$Projects$Locations$Catalogs$Completiondata; controls: Resource$Projects$Locations$Catalogs$Controls; + generativeQuestion: Resource$Projects$Locations$Catalogs$Generativequestion; + generativeQuestions: Resource$Projects$Locations$Catalogs$Generativequestions; models: Resource$Projects$Locations$Catalogs$Models; operations: Resource$Projects$Locations$Catalogs$Operations; placements: Resource$Projects$Locations$Catalogs$Placements; @@ -4139,6 +4402,14 @@ export namespace retail_v2beta { this.controls = new Resource$Projects$Locations$Catalogs$Controls( this.context ); + this.generativeQuestion = + new Resource$Projects$Locations$Catalogs$Generativequestion( + this.context + ); + this.generativeQuestions = + new Resource$Projects$Locations$Catalogs$Generativequestions( + this.context + ); this.models = new Resource$Projects$Locations$Catalogs$Models( this.context ); @@ -4636,6 +4907,103 @@ export namespace retail_v2beta { } } + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature, + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + getGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+catalog}/generativeQuestionFeature' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists all the Catalogs associated with the project. * @@ -5110,43 +5478,238 @@ export namespace retail_v2beta { ); } } - } - export interface Params$Resource$Projects$Locations$Catalogs$Completequery - extends StandardParameters { - /** - * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. - */ - 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). - */ - dataset?: string; - /** - * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. - */ - deviceType?: string; - /** - * 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. - */ - entity?: string; - /** - * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. - */ - languageCodes?: string[]; - /** - * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. - */ - maxSuggestions?: number; - /** - * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + * Allows management of individual questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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?: string; - /** + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestion( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+catalog}/generativeQuestion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Manages overal generative question feature state -- enables toggling feature on and off. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params?: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options?: MethodOptions + ): GaxiosPromise; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + params: Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature, + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + callback: BodyResponseCallback + ): void; + updateGenerativeQuestionFeature( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+catalog}/generativeQuestionFeature' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['catalog'], + pathParams: ['catalog'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Completequery + extends StandardParameters { + /** + * Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/x/locations/global/catalogs/default_catalog`. + */ + 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). + */ + dataset?: string; + /** + * The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`. + */ + deviceType?: string; + /** + * 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. + */ + entity?: string; + /** + * Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. + */ + languageCodes?: string[]; + /** + * Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. + */ + maxSuggestions?: number; + /** + * Required. The query used to generate suggestions. The maximum number of allowed characters is 255. + */ + query?: string; + /** * Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ visitorId?: string; @@ -5184,6 +5747,13 @@ export namespace retail_v2beta { */ catalog?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Getgenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + } export interface Params$Resource$Projects$Locations$Catalogs$List extends StandardParameters { /** @@ -5259,6 +5829,38 @@ export namespace retail_v2beta { */ requestBody?: Schema$GoogleCloudRetailV2betaCompletionConfig; } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestion + extends StandardParameters { + /** + * Required. Resource name of the catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaGenerativeQuestionConfig; + } + export interface Params$Resource$Projects$Locations$Catalogs$Updategenerativequestionfeature + extends StandardParameters { + /** + * Required. Resource name of the affected catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + catalog?: string; + /** + * Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaGenerativeQuestionsFeatureConfig; + } export class Resource$Projects$Locations$Catalogs$Attributesconfig { context: APIRequestContext; @@ -7911,6 +8513,236 @@ export namespace retail_v2beta { requestBody?: Schema$GoogleCloudRetailV2betaControl; } + export class Resource$Projects$Locations$Catalogs$Generativequestion { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Allows management of multiple questions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v2beta/{+parent}/generativeQuestion:batchUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Catalogs$Generativequestion$Batchupdate + extends StandardParameters { + /** + * Optional. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaBatchUpdateGenerativeQuestionConfigsRequest; + } + + export class Resource$Projects$Locations$Catalogs$Generativequestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns all questions for a given catalog. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional 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$Catalogs$Generativequestions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Catalogs$Generativequestions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Generativequestions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Generativequestions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+parent}/generativeQuestions').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$Catalogs$Generativequestions$List + extends StandardParameters { + /** + * Required. Resource name of the parent catalog. Format: projects/{project\}/locations/{location\}/catalogs/{catalog\} + */ + parent?: string; + } + export class Resource$Projects$Locations$Catalogs$Models { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 99f898d48b..be81ae4407 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -347,7 +347,7 @@ export namespace run_v1 { */ ports?: Schema$ContainerPort[]; /** - * Not supported by Cloud Run. + * Readiness probe to be used for health checks. Not supported by Cloud Run. */ readinessProbe?: Schema$Probe; /** @@ -2111,7 +2111,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/enable-automatic-updates`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/image-uri`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + * 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/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; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index ce1c52d1a7..678d4b8b65 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -1065,7 +1065,7 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2RevisionScaling { /** - * Optional. Maximum number of serving instances that this resource should have. + * Optional. Maximum number of serving instances that this resource should have. When unspecified, the field is set to the server default value of 100. For more information see https://cloud.google.com/run/docs/configuring/max-instances */ maxInstanceCount?: number | null; /** @@ -1262,6 +1262,10 @@ export namespace run_v2 { * 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 setting should not be used with external ingress. + */ + invokerIamDisabled?: boolean | null; /** * Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. */ @@ -1349,9 +1353,13 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2ServiceScaling { /** - * Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. (BETA) + * Optional. total min instances for the service. This number of instances is divided among all revisions with specified traffic based on the percent of traffic they are receiving. */ minInstanceCount?: number | null; + /** + * Optional. The scaling mode for the service. + */ + scalingMode?: string | null; } /** * Location of the source in an archive file in Google Cloud Storage. @@ -1411,6 +1419,10 @@ export namespace run_v2 { * URI of the base builder image in Artifact Registry being used in the build. Used to opt into automatic base image updates. */ baseImageUri?: string | null; + /** + * Warning message for the base image. + */ + baseImageWarning?: string | null; /** * Cloud Build operation to be polled via CloudBuild API. */ diff --git a/src/apis/searchads360/v0.ts b/src/apis/searchads360/v0.ts index cf5540f8b5..491f98dc4e 100644 --- a/src/apis/searchads360/v0.ts +++ b/src/apis/searchads360/v0.ts @@ -620,10 +620,18 @@ export namespace searchads360_v0 { * Conversions from when a customer clicks on an ad on one device, then converts on a different device or browser. Cross-device conversions are already included in all_conversions. */ crossDeviceConversions?: number | null; + /** + * The number of cross-device conversions by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + */ + crossDeviceConversionsByConversionDate?: number | null; /** * The sum of the value of cross-device conversions. */ crossDeviceConversionsValue?: number | null; + /** + * The sum of cross-device conversions value by conversion date. Details for the by_conversion_date columns are available at https://support.google.com/sa360/answer/9250611. + */ + crossDeviceConversionsValueByConversionDate?: number | null; /** * Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause */ @@ -644,6 +652,14 @@ export namespace searchads360_v0 { * The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions). */ ctr?: number | null; + /** + * The percentage of clicks that have been filtered out of your total number of clicks (filtered + non-filtered clicks) due to being general invalid clicks. These are clicks Google considers illegitimate that are detected through routine means of filtration (that is, known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + */ + generalInvalidClickRate?: number | null; + /** + * Number of general invalid clicks. These are a subset of your invalid clicks that are detected through routine means of filtration (such as known invalid data-center traffic, bots and spiders or other crawlers, irregular patterns, etc.). You're not charged for them, and they don't affect your account statistics. See the help page at https://support.google.com/campaignmanager/answer/6076504 for details. + */ + generalInvalidClicks?: string | null; /** * The creative historical quality score. */ @@ -1824,7 +1840,7 @@ export namespace searchads360_v0 { */ export interface Schema$GoogleAdsSearchads360V0Resources_Campaign_SelectiveOptimization { /** - * The selected set of conversion actions for optimizing this campaign. + * The selected set of resource names for conversion actions for optimizing this campaign. */ conversionActions?: string[] | null; } @@ -2119,6 +2135,10 @@ export namespace searchads360_v0 { * Output only. The timestamp when this ad_group was created. The timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" format. */ creationTime?: string | null; + /** + * Output only. The resource names of effective labels attached to this ad group. An effective label is a label inherited or directly assigned to this ad group. + */ + effectiveLabels?: string[] | null; /** * Output only. Date when the ad group ends serving ads. By default, the ad group ends on the ad group's end date. If this field is set, then the ad group ends at the end of the specified date in the customer's time zone. This field is only available for Microsoft Advertising and Facebook gateway accounts. Format: YYYY-MM-DD Example: 2019-03-14 */ @@ -2428,6 +2448,27 @@ export namespace searchads360_v0 { */ resourceName?: string | null; } + /** + * A relationship between an ad group and an effective label. An effective label is a label inherited or directly assigned to this ad group. + */ + export interface Schema$GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel { + /** + * Immutable. The ad group to which the effective label is attached. + */ + adGroup?: string | null; + /** + * Immutable. The effective label assigned to the ad group. + */ + label?: string | null; + /** + * Output only. The ID of the Customer which owns the effective label. + */ + ownerCustomerId?: string | null; + /** + * Immutable. The resource name of the ad group effective label. Ad group effective label resource names have the form: `customers/{customer_id\}/adGroupEffectiveLabels/{ad_group_id\}~{label_id\}` + */ + resourceName?: string | null; + } /** * A relationship between an ad group and a label. */ @@ -2838,7 +2879,7 @@ export namespace searchads360_v0 { */ advertisingChannelType?: string | null; /** - * Portfolio bidding strategy used by campaign. + * The resource name of the portfolio bidding strategy used by the campaign. */ biddingStrategy?: string | null; /** @@ -2850,7 +2891,7 @@ export namespace searchads360_v0 { */ biddingStrategyType?: string | null; /** - * The budget of the campaign. + * The resource name of the campaign budget of the campaign. */ campaignBudget?: string | null; /** @@ -2865,6 +2906,10 @@ export namespace searchads360_v0 { * The setting for controlling Dynamic Search Ads (DSA). */ dynamicSearchAdsSetting?: Schema$GoogleAdsSearchads360V0Resources_Campaign_DynamicSearchAdsSetting; + /** + * Output only. The resource names of effective labels attached to this campaign. An effective label is a label inherited or directly assigned to this campaign. + */ + effectiveLabels?: string[] | null; /** * The last day of the campaign in serving customer's timezone in YYYY-MM-DD format. On create, defaults to 2037-12-30, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 2037-12-30. */ @@ -3147,6 +3192,27 @@ export namespace searchads360_v0 { */ webpage?: Schema$GoogleAdsSearchads360V0Common__WebpageInfo; } + /** + * Represents a relationship between a campaign and an effective label. An effective label is a label inherited or directly assigned to this campaign. + */ + export interface Schema$GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel { + /** + * Immutable. The campaign to which the effective label is attached. + */ + campaign?: string | null; + /** + * Immutable. The effective label assigned to the campaign. + */ + label?: string | null; + /** + * Output only. The ID of the Customer which owns the effective label. + */ + ownerCustomerId?: string | null; + /** + * Immutable. Name of the resource. CampaignEffectivelabel resource names have the form: `customers/{customer_id\}/campaignEffectiveLabels/{campaign_id\}~{label_id\}` + */ + resourceName?: string | null; + } /** * Represents a relationship between a campaign and a label. */ @@ -4183,6 +4249,10 @@ export namespace searchads360_v0 { * The ad group criterion label referenced in the query. */ adGroupCriterionLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupCriterionLabel; + /** + * The ad group effective label referenced in the query. + */ + adGroupEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__AdGroupEffectiveLabel; /** * The ad group label referenced in the query. */ @@ -4255,6 +4325,10 @@ export namespace searchads360_v0 { * The campaign criterion referenced in the query. */ campaignCriterion?: Schema$GoogleAdsSearchads360V0Resources__CampaignCriterion; + /** + * The campaign effective label referenced in the query. + */ + campaignEffectiveLabel?: Schema$GoogleAdsSearchads360V0Resources__CampaignEffectiveLabel; /** * The campaign label referenced in the query. */ diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts index 2bcb3f22fb..8e2d1a61d4 100644 --- a/src/apis/secretmanager/v1.ts +++ b/src/apis/secretmanager/v1.ts @@ -448,7 +448,7 @@ export namespace secretmanager_v1 { */ createTime?: string | null; /** - * Optional. The customer-managed encryption configuration of the Regionalised Secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. + * Optional. The customer-managed encryption configuration of the regionalized secrets. If no configuration is provided, Google-managed default encryption is used. Updates to the Secret encryption configuration only apply to SecretVersions added afterwards. They do not apply retroactively to existing SecretVersions. */ customerManagedEncryption?: Schema$CustomerManagedEncryption; /** @@ -518,7 +518,7 @@ export namespace secretmanager_v1 { */ createTime?: string | null; /** - * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a Regionalised Secret. + * Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used and Secret is a regionalized secret. */ customerManagedEncryption?: Schema$CustomerManagedEncryptionStatus; /** diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index d642e5c250..e34b631c49 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -536,6 +536,10 @@ export namespace securitycenter_v1 { * Represents an Azure resource group. */ export interface Schema$AzureResourceGroup { + /** + * The ID of the Azure resource group. + */ + id?: string | null; /** * The name of the Azure resource group. This is not a UUID. */ @@ -558,6 +562,10 @@ export namespace securitycenter_v1 { * Represents a Microsoft Entra tenant. */ export interface Schema$AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ @@ -660,6 +668,15 @@ export namespace securitycenter_v1 { */ muteState?: string | null; } + /** + * YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: \> instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: \> firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: \> instance.networkInterfaces.exists(net, firewall.network == net.network) output: \> {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name\} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. + */ + export interface Schema$CelPolicySpec { + /** + * The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. + */ + spec?: string | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -1640,6 +1657,10 @@ export namespace securitycenter_v1 { * Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. */ export interface Schema$GoogleCloudSecuritycenterV1CustomConfig { + /** + * The CEL policy spec attached to the custom module. + */ + celPolicy?: Schema$CelPolicySpec; /** * Custom output properties. */ @@ -2387,6 +2408,10 @@ export namespace securitycenter_v1 { * Represents an Azure resource group. */ export interface Schema$GoogleCloudSecuritycenterV2AzureResourceGroup { + /** + * The ID of the Azure resource group. + */ + id?: string | null; /** * The name of the Azure resource group. This is not a UUID. */ @@ -2409,6 +2434,10 @@ export namespace securitycenter_v1 { * Represents a Microsoft Entra tenant. */ export interface Schema$GoogleCloudSecuritycenterV2AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ @@ -7717,104 +7746,6 @@ export namespace securitycenter_v1 { this.context = context; } - /** - * Creates a mute 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. - */ - create( - params: Params$Resource$Folders$Locations$Muteconfigs$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Folders$Locations$Muteconfigs$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Folders$Locations$Muteconfigs$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Folders$Locations$Muteconfigs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Folders$Locations$Muteconfigs$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Folders$Locations$Muteconfigs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Locations$Muteconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Muteconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/muteConfigs').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 mute config. * @@ -7996,97 +7927,6 @@ export namespace securitycenter_v1 { } } - /** - * Lists mute configs. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional 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$Muteconfigs$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Folders$Locations$Muteconfigs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Folders$Locations$Muteconfigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Folders$Locations$Muteconfigs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Folders$Locations$Muteconfigs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Folders$Locations$Muteconfigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Locations$Muteconfigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Locations$Muteconfigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}').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 mute config. * @@ -8183,22 +8023,6 @@ export namespace securitycenter_v1 { } } - export interface Params$Resource$Folders$Locations$Muteconfigs$Create - extends StandardParameters { - /** - * Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less. - */ - muteConfigId?: string; - /** - * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudSecuritycenterV1MuteConfig; - } export interface Params$Resource$Folders$Locations$Muteconfigs$Delete extends StandardParameters { /** @@ -8213,21 +8037,6 @@ export namespace securitycenter_v1 { */ name?: string; } - export interface Params$Resource$Folders$Locations$Muteconfigs$List - extends StandardParameters { - /** - * The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. - */ - parent?: string; - } export interface Params$Resource$Folders$Locations$Muteconfigs$Patch extends StandardParameters { /** @@ -13586,139 +13395,40 @@ export namespace securitycenter_v1 { } /** - * Creates a mute config. + * Deletes an existing mute 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. */ - create( - params: Params$Resource$Organizations$Locations$Muteconfigs$Create, + delete( + params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Organizations$Locations$Muteconfigs$Create, + delete( + params?: Params$Resource$Organizations$Locations$Muteconfigs$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Locations$Muteconfigs$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Organizations$Locations$Muteconfigs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Locations$Muteconfigs$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Organizations$Locations$Muteconfigs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Muteconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Organizations$Locations$Muteconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/muteConfigs').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 mute 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. - */ - delete( - params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Organizations$Locations$Muteconfigs$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Organizations$Locations$Muteconfigs$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Muteconfigs$Delete - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Muteconfigs$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -13866,97 +13576,6 @@ export namespace securitycenter_v1 { } } - /** - * Lists mute configs. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional 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$Muteconfigs$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Organizations$Locations$Muteconfigs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Locations$Muteconfigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Muteconfigs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Organizations$Locations$Muteconfigs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Organizations$Locations$Muteconfigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Locations$Muteconfigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Locations$Muteconfigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}').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 mute config. * @@ -14054,22 +13673,6 @@ export namespace securitycenter_v1 { } } - export interface Params$Resource$Organizations$Locations$Muteconfigs$Create - extends StandardParameters { - /** - * Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less. - */ - muteConfigId?: string; - /** - * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudSecuritycenterV1MuteConfig; - } export interface Params$Resource$Organizations$Locations$Muteconfigs$Delete extends StandardParameters { /** @@ -14084,21 +13687,6 @@ export namespace securitycenter_v1 { */ name?: string; } - export interface Params$Resource$Organizations$Locations$Muteconfigs$List - extends StandardParameters { - /** - * The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. - */ - parent?: string; - } export interface Params$Resource$Organizations$Locations$Muteconfigs$Patch extends StandardParameters { /** @@ -21758,104 +21346,6 @@ export namespace securitycenter_v1 { this.context = context; } - /** - * Creates a mute 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. - */ - create( - params: Params$Resource$Projects$Locations$Muteconfigs$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Muteconfigs$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Muteconfigs$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Muteconfigs$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Muteconfigs$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Muteconfigs$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Muteconfigs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Muteconfigs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/muteConfigs').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 mute config. * @@ -22037,97 +21527,6 @@ export namespace securitycenter_v1 { } } - /** - * Lists mute configs. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional 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$Muteconfigs$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Muteconfigs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Muteconfigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Muteconfigs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Muteconfigs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Muteconfigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Muteconfigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Muteconfigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}').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 mute config. * @@ -22224,22 +21623,6 @@ export namespace securitycenter_v1 { } } - export interface Params$Resource$Projects$Locations$Muteconfigs$Create - extends StandardParameters { - /** - * Required. Unique identifier provided by the client within the parent scope. It must consist of only lowercase letters, numbers, and hyphens, must start with a letter, must end with either a letter or a number, and must be 63 characters or less. - */ - muteConfigId?: string; - /** - * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudSecuritycenterV1MuteConfig; - } export interface Params$Resource$Projects$Locations$Muteconfigs$Delete extends StandardParameters { /** @@ -22254,21 +21637,6 @@ export namespace securitycenter_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Muteconfigs$List - extends StandardParameters { - /** - * The maximum number of configs to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListMuteConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMuteConfigs` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. - */ - parent?: string; - } export interface Params$Resource$Projects$Locations$Muteconfigs$Patch extends StandardParameters { /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index b58bde83c4..a0d76ff31b 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -436,6 +436,10 @@ export namespace securitycenter_v1beta1 { * Represents an Azure resource group. */ export interface Schema$AzureResourceGroup { + /** + * The ID of the Azure resource group. + */ + id?: string | null; /** * The name of the Azure resource group. This is not a UUID. */ @@ -458,6 +462,10 @@ export namespace securitycenter_v1beta1 { * Represents a Microsoft Entra tenant. */ export interface Schema$AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ @@ -529,6 +537,15 @@ export namespace securitycenter_v1beta1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * YAML-based rule that uses CEL, which supports the declaration of variables and a filtering predicate. A vulnerable resource is emitted if the evaluation is false. Given: 1) the resource types as: - resource_types: "compute.googleapis.com/Instance" - resource_types: "compute.googleapis.com/Firewall" 2) the CEL policy spec as: name: bad_instance resource_filters: - name: instance resource_type: compute.googleapis.com/Instance filter: \> instance.status == 'RUNNING' && 'public' in instance.tags.items - name: firewall resource_type: compute.googleapis.com/Firewall filter: \> firewall.direction == 'INGRESS' && !firewall.disabled && firewall.allowed.exists(rule, rule.IPProtocol.upperAscii() in ['TCP', 'ALL'] && rule.ports.exists(port, network.portsInRange(port, '11-256'))) rule: match: - predicate: \> instance.networkInterfaces.exists(net, firewall.network == net.network) output: \> {'message': 'Compute instance with publicly accessible ports', 'instance': instance.name\} Users are able to join resource types together using the exact format as Kubernetes Validating Admission policies. + */ + export interface Schema$CelPolicySpec { + /** + * The CEL policy to evaluate to produce findings. A finding is generated when the policy validation evaluates to false. + */ + spec?: string | null; + } /** * Fields related to Google Cloud Armor findings. */ @@ -1457,6 +1474,10 @@ export namespace securitycenter_v1beta1 { * Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. */ export interface Schema$GoogleCloudSecuritycenterV1CustomConfig { + /** + * The CEL policy spec attached to the custom module. + */ + celPolicy?: Schema$CelPolicySpec; /** * Custom output properties. */ @@ -2204,6 +2225,10 @@ export namespace securitycenter_v1beta1 { * Represents an Azure resource group. */ export interface Schema$GoogleCloudSecuritycenterV2AzureResourceGroup { + /** + * The ID of the Azure resource group. + */ + id?: string | null; /** * The name of the Azure resource group. This is not a UUID. */ @@ -2226,6 +2251,10 @@ export namespace securitycenter_v1beta1 { * Represents a Microsoft Entra tenant. */ export interface Schema$GoogleCloudSecuritycenterV2AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index 7bb7d20afc..18db93026d 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -394,6 +394,10 @@ export namespace securitycenter_v1beta2 { * Represents a Microsoft Entra tenant. */ export interface Schema$AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ @@ -2137,6 +2141,10 @@ export namespace securitycenter_v1beta2 { * Represents a Microsoft Entra tenant. */ export interface Schema$GoogleCloudSecuritycenterV2AzureTenant { + /** + * The display name of the Azure tenant. + */ + displayName?: string | null; /** * The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". */ @@ -6201,6 +6209,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Folders$Eventthreatdetectionsettings { @@ -6315,6 +6327,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Folders$Rapidvulnerabilitydetectionsettings { @@ -6543,6 +6559,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Folders$Virtualmachinethreatdetectionsettings { @@ -6657,6 +6677,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Folders$Websecurityscannersettings { @@ -6769,6 +6793,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Organizations { @@ -8396,6 +8424,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Organizations$Eventthreatdetectionsettings { @@ -8510,6 +8542,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Organizations$Rapidvulnerabilitydetectionsettings { @@ -8738,6 +8774,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Organizations$Virtualmachinethreatdetectionsettings { @@ -8852,6 +8892,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Organizations$Websecurityscannersettings { @@ -8964,6 +9008,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects { @@ -10492,6 +10540,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects$Eventthreatdetectionsettings { @@ -10606,6 +10658,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the EventThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects$Locations { @@ -10957,6 +11013,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the ContainerThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects$Rapidvulnerabilitydetectionsettings { @@ -11185,6 +11245,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the SecurityHealthAnalyticsSettings to calculate. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects$Virtualmachinethreatdetectionsettings { @@ -11299,6 +11363,10 @@ export namespace securitycenter_v1beta2 { * Required. The name of the VirtualMachineThreatDetectionSettings to calculate. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } export class Resource$Projects$Websecurityscannersettings { @@ -11411,5 +11479,9 @@ export namespace securitycenter_v1beta2 { * Required. The name of the WebSecurityScannerSettings to calculate. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; + /** + * Optional. When set, will only retrieve the modules that are in scope. By default, all modules will be shown. + */ + showEligibleModulesOnly?: boolean; } } diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index d81daaf437..54d7c522a1 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -425,6 +425,10 @@ export namespace serviceconsumermanagement_v1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -693,6 +697,15 @@ export namespace serviceconsumermanagement_v1 { */ options?: Schema$Option[]; } + /** + * Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. + */ + export interface Schema$ExperimentalFeatures { + /** + * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + */ + restAsyncIoEnabled?: boolean | null; + } /** * A single field of a message type. */ @@ -1099,6 +1112,10 @@ export namespace serviceconsumermanagement_v1 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1114,7 +1131,7 @@ export namespace serviceconsumermanagement_v1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1333,6 +1350,10 @@ export namespace serviceconsumermanagement_v1 { * Some settings. */ common?: Schema$CommonLanguageSettings; + /** + * Experimental features to be included during client library generation. + */ + experimentalFeatures?: Schema$ExperimentalFeatures; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -1423,6 +1444,15 @@ export namespace serviceconsumermanagement_v1 { */ tenancyUnits?: Schema$TenancyUnit[]; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ @@ -1924,7 +1954,7 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$V1DefaultIdentity { /** - * The email address of the default identity. + * The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email. */ email?: string | null; /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index ec485867ab..3533dcc966 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -369,6 +369,10 @@ export namespace serviceconsumermanagement_v1beta1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. @@ -619,6 +623,15 @@ export namespace serviceconsumermanagement_v1beta1 { */ options?: Schema$Option[]; } + /** + * Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. + */ + export interface Schema$ExperimentalFeatures { + /** + * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + */ + restAsyncIoEnabled?: boolean | null; + } /** * A single field of a message type. */ @@ -999,6 +1012,10 @@ export namespace serviceconsumermanagement_v1beta1 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1014,7 +1031,7 @@ export namespace serviceconsumermanagement_v1beta1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1220,6 +1237,10 @@ export namespace serviceconsumermanagement_v1beta1 { * Some settings. */ common?: Schema$CommonLanguageSettings; + /** + * Experimental features to be included during client library generation. + */ + experimentalFeatures?: Schema$ExperimentalFeatures; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -1288,6 +1309,15 @@ export namespace serviceconsumermanagement_v1beta1 { */ common?: Schema$CommonLanguageSettings; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ @@ -1627,7 +1657,7 @@ export namespace serviceconsumermanagement_v1beta1 { */ export interface Schema$V1beta1DefaultIdentity { /** - * The email address of the default identity. + * The email address of the default identity. Calling GenerateDefaultIdentity with a deleted or purged default identity should expect does_not_exist@invalid-project.iam.gserviceaccount.com placeholder email. */ email?: string | null; /** diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index bcce1894d7..70d2e18310 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -430,6 +430,10 @@ export namespace servicemanagement_v1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * Output generated from semantically comparing two versions of a service configuration. Includes detailed information about a field that have changed with applicable advice about potential consequences for the change, such as backwards-incompatibility. @@ -1324,7 +1328,7 @@ export namespace servicemanagement_v1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1703,6 +1707,15 @@ export namespace servicemanagement_v1 { */ common?: Schema$CommonLanguageSettings; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 85208ce977..57405ca8bd 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -556,6 +556,10 @@ export namespace servicenetworking_v1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. @@ -1508,7 +1512,7 @@ export namespace servicenetworking_v1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1962,6 +1966,15 @@ export namespace servicenetworking_v1 { */ requestedAddress?: string | null; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index f20adc522b..2b7eb4032e 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -457,6 +457,10 @@ export namespace servicenetworking_v1beta { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * Represents a private connection resource. A private connection is implemented as a VPC Network Peering connection between a service producer's VPC network and a service consumer's VPC network. @@ -1303,7 +1307,7 @@ export namespace servicenetworking_v1beta { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1688,6 +1692,15 @@ export namespace servicenetworking_v1beta { */ rangeName?: string | null; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * `Service` is the root object of Google API service configuration (service config). It describes the basic information about a logical service, such as the service name and the user-facing title, and delegates other aspects to sub-sections. Each sub-section is either a proto message or a repeated proto message that configures a specific aspect, such as auth. For more information, see each proto message definition. Example: type: google.api.Service name: calendar.googleapis.com title: Google Calendar API apis: - name: google.calendar.v3.Calendar visibility: rules: - selector: "google.calendar.v3.*" restriction: PREVIEW backend: rules: - selector: "google.calendar.v3.*" address: calendar.example.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth */ diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index bc5dfce379..291e4615fd 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -515,6 +515,10 @@ export namespace serviceusage_v1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. @@ -867,6 +871,15 @@ export namespace serviceusage_v1 { */ options?: Schema$Option[]; } + /** + * Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. + */ + export interface Schema$ExperimentalFeatures { + /** + * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + */ + restAsyncIoEnabled?: boolean | null; + } /** * A single field of a message type. */ @@ -1602,6 +1615,10 @@ export namespace serviceusage_v1 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1617,7 +1634,7 @@ export namespace serviceusage_v1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1832,6 +1849,10 @@ export namespace serviceusage_v1 { * Some settings. */ common?: Schema$CommonLanguageSettings; + /** + * Experimental features to be included during client library generation. + */ + experimentalFeatures?: Schema$ExperimentalFeatures; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -1946,6 +1967,15 @@ export namespace serviceusage_v1 { */ common?: Schema$CommonLanguageSettings; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * Service identity for a service. This is the identity that service producer should use to access consumer resources. */ diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 5f479375b0..738e44bfd1 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -502,6 +502,10 @@ export namespace serviceusage_v1beta1 { * Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest */ referenceDocsUri?: string | null; + /** + * Configuration for which RPCs should be generated in the GAPIC client. + */ + selectiveGapicGeneration?: Schema$SelectiveGapicGeneration; } /** * Consumer Policy is a set of rules that define what services or service groups can be used for a cloud resource hierarchy. @@ -907,6 +911,15 @@ export namespace serviceusage_v1beta1 { */ options?: Schema$Option[]; } + /** + * Experimental features to be included during client library generation. These fields will be deprecated once the feature graduates and is enabled by default. + */ + export interface Schema$ExperimentalFeatures { + /** + * Enables generation of asynchronous REST clients if `rest` transport is enabled. By default, asynchronous REST clients will not be generated. This feature will be enabled by default 1 month after launching the feature in preview packages. + */ + restAsyncIoEnabled?: boolean | null; + } /** * A single field of a message type. */ @@ -1715,6 +1728,10 @@ export namespace serviceusage_v1beta1 { * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period. */ samplePeriod?: string | null; + /** + * The scope of the timeseries data of the metric. + */ + timeSeriesResourceHierarchyLevel?: string[] | null; } /** * Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call. @@ -1730,7 +1747,7 @@ export namespace serviceusage_v1beta1 { selector?: string | null; } /** - * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inherting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} + * Declares an API Interface to be included in this interface. The including interface must redeclare all the methods from the included interface, but documentation and options are inherited as follows: - If after comment and whitespace stripping, the documentation string of the redeclared method is empty, it will be inherited from the original method. - Each annotation belonging to the service config (http, visibility) which is not set in the redeclared method will be inherited. - If an http annotation is inherited, the path pattern will be modified as follows. Any version prefix will be replaced by the version of the including interface plus the root path if specified. Example of a simple mixin: package google.acl.v1; service AccessControl { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v1/{resource=**\}:getAcl"; \} \} package google.storage.v2; service Storage { // rpc GetAcl(GetAclRequest) returns (Acl); // Get a data record. rpc GetData(GetDataRequest) returns (Data) { option (google.api.http).get = "/v2/{resource=**\}"; \} \} Example of a mixin configuration: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl The mixin construct implies that all methods in `AccessControl` are also declared with same name and request/response types in `Storage`. A documentation generator or annotation processor will see the effective `Storage.GetAcl` method after inheriting documentation and annotations as follows: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/{resource=**\}:getAcl"; \} ... \} Note how the version in the path pattern changed from `v1` to `v2`. If the `root` field in the mixin is specified, it should be a relative path under which inherited HTTP paths are placed. Example: apis: - name: google.storage.v2.Storage mixins: - name: google.acl.v1.AccessControl root: acls This implies the following inherited HTTP annotation: service Storage { // Get the underlying ACL object. rpc GetAcl(GetAclRequest) returns (Acl) { option (google.api.http).get = "/v2/acls/{resource=**\}:getAcl"; \} ... \} */ export interface Schema$Mixin { /** @@ -1983,6 +2000,10 @@ export namespace serviceusage_v1beta1 { * Some settings. */ common?: Schema$CommonLanguageSettings; + /** + * Experimental features to be included during client library generation. + */ + experimentalFeatures?: Schema$ExperimentalFeatures; } /** * Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project\}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 @@ -2143,6 +2164,15 @@ export namespace serviceusage_v1beta1 { */ common?: Schema$CommonLanguageSettings; } + /** + * This message is used to configure the generation of a subset of the RPCs in a service for client libraries. + */ + export interface Schema$SelectiveGapicGeneration { + /** + * An allowlist of the fully qualified names of RPCs that should be included on public client surfaces. + */ + methods?: string[] | null; + } /** * A service that is available for use by the consumer. */ diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index efc29282be..0ad15d0ab7 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -4203,7 +4203,7 @@ export namespace sheets_v4 { */ defaultFormat?: Schema$CellFormat; /** - * Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the allowlisting feature. + * Whether to allow external URL access for image and import functions. Read only when true. When false, you can set to true. This value will be bypassed and always return true if the admin has enabled the [allowlisting feature](https://support.google.com/a?p=url_allowlist). */ importFunctionsExternalUrlAccessAllowed?: boolean | null; /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 1a13301e0c..46c8073e3b 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -1771,6 +1771,19 @@ export namespace spanner_v1 { */ targetConfig?: string | null; } + /** + * When a read-write transaction is executed on a multiplexed session, this precommit token is sent back to the client as a part of the [Transaction] message in the BeginTransaction response and also as a part of the [ResultSet] and [PartialResultSet] responses. + */ + export interface Schema$MultiplexedSessionPrecommitToken { + /** + * Opaque precommit token. + */ + precommitToken?: string | null; + /** + * An incrementing seq number is generated on every precommit token that is returned. Clients should remember the precommit token with the highest sequence number from the current transaction attempt. + */ + seqNum?: number | null; + } /** * A modification to one or more Cloud Spanner rows. Mutations can be applied to a Cloud Spanner database by sending them in a Commit call. */ @@ -2572,6 +2585,10 @@ export namespace spanner_v1 { * `id` may be used to identify the transaction in subsequent Read, ExecuteSql, Commit, or Rollback calls. Single-use read-only transactions do not have IDs, because single-use transactions do not support multiple requests. */ id?: string | null; + /** + * A precommit token will be included in the response of a BeginTransaction request if the read-write transaction is on a multiplexed session and a mutation_key was specified in the BeginTransaction. The precommit token with the highest sequence number from this transaction attempt should be passed to the Commit request for this transaction. + */ + precommitToken?: Schema$MultiplexedSessionPrecommitToken; /** * For snapshot read-only transactions, the read timestamp chosen for the transaction. Not returned by default: see TransactionOptions.ReadOnly.return_read_timestamp. A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: `"2014-10-02T15:01:23.045123456Z"`. */ diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 1e24a3eb9c..eace7dac18 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -284,6 +284,10 @@ export namespace sqladmin_v1 { * This is always `sql#backupContext`. */ kind?: string | null; + /** + * The name of the backup. Format: projects/{project\}/backups/{backup\} + */ + name?: string | null; } /** * Backup Reencryption Config @@ -1278,6 +1282,27 @@ export namespace sqladmin_v1 { */ kind?: string | null; } + /** + * Instances ListServerCertificates response. + */ + export interface Schema$InstancesListServerCertificatesResponse { + /** + * The `sha1_fingerprint` of the active certificate from `server_certs`. + */ + activeVersion?: string | null; + /** + * List of server CA certificates for the instance. + */ + caCerts?: Schema$SslCert[]; + /** + * This is always `sql#instancesListServerCertificates`. + */ + kind?: string | null; + /** + * List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list. + */ + serverCerts?: Schema$SslCert[]; + } /** * Database Instance reencrypt request. */ @@ -1291,10 +1316,18 @@ export namespace sqladmin_v1 { * Database instance restore backup request. */ export interface Schema$InstancesRestoreBackupRequest { + /** + * The name of the backup to restore from in following format: projects/{project-id\}/backups/{backup-uid\} Only one of restore_backup_context or backup can be passed to the input. + */ + backup?: string | null; /** * Parameters required to perform the restore backup operation. */ restoreBackupContext?: Schema$RestoreBackupContext; + /** + * Optional. Restore instance settings overrides the instance settings stored as part of the backup. Instance's major database version cannot be changed and the disk size can only be increased. This feature is only available for restores to new instances using the backup name. + */ + restoreInstanceSettings?: Schema$DatabaseInstance; } /** * Rotate server CA request. @@ -1305,6 +1338,15 @@ export namespace sqladmin_v1 { */ rotateServerCaContext?: Schema$RotateServerCaContext; } + /** + * Rotate server certificate request. + */ + export interface Schema$InstancesRotateServerCertificateRequest { + /** + * Optional. Contains details about the rotate server certificate operation. + */ + rotateServerCertificateContext?: Schema$RotateServerCertificateContext; + } /** * Instance truncate log request. */ @@ -1666,6 +1708,10 @@ export namespace sqladmin_v1 { * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string | null; + /** + * List of warnings that occurred while handling the request. + */ + warnings?: Schema$ApiWarning[]; } /** * Read-only password status. @@ -1817,6 +1863,19 @@ export namespace sqladmin_v1 { */ nextVersion?: string | null; } + /** + * Instance rotate server certificate context. + */ + export interface Schema$RotateServerCertificateContext { + /** + * Optional. This is always `sql#rotateServerCertificateContext`. + */ + kind?: string | null; + /** + * The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version. + */ + nextVersion?: string | null; + } /** * Database instance settings. */ @@ -4023,6 +4082,96 @@ export namespace sqladmin_v1 { } } + /** + * Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa 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. + */ + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: StreamMethodOptions + ): GaxiosPromise; + addServerCertificate( + params?: Params$Resource$Instances$Addservercertificate, + options?: MethodOptions + ): GaxiosPromise; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + callback: BodyResponseCallback + ): void; + addServerCertificate( + callback: BodyResponseCallback + ): void; + addServerCertificate( + paramsOrCallback?: + | Params$Resource$Instances$Addservercertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addservercertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addservercertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/addServerCertificate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. * @@ -4990,6 +5139,103 @@ export namespace sqladmin_v1 { } } + /** + * Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: StreamMethodOptions + ): GaxiosPromise; + ListServerCertificates( + params?: Params$Resource$Instances$Listservercertificates, + options?: MethodOptions + ): GaxiosPromise; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + callback: BodyResponseCallback + ): void; + ListServerCertificates( + paramsOrCallback?: + | Params$Resource$Instances$Listservercertificates + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Listservercertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Listservercertificates; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/listServerCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics. * @@ -5699,6 +5945,96 @@ export namespace sqladmin_v1 { } } + /** + * Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa 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. + */ + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: StreamMethodOptions + ): GaxiosPromise; + RotateServerCertificate( + params?: Params$Resource$Instances$Rotateservercertificate, + options?: MethodOptions + ): GaxiosPromise; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + paramsOrCallback?: + | Params$Resource$Instances$Rotateservercertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Rotateservercertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Rotateservercertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/rotateServerCertificate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Starts the replication in the read replica instance. * @@ -6164,6 +6500,17 @@ export namespace sqladmin_v1 { */ project?: string; } + export interface Params$Resource$Instances$Addservercertificate + extends StandardParameters { + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Clone extends StandardParameters { /** * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. @@ -6180,6 +6527,22 @@ export namespace sqladmin_v1 { requestBody?: Schema$InstancesCloneRequest; } export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Flag to opt-in for final backup. By default, it is turned off. + */ + enableFinalBackup?: boolean; + /** + * Optional. The description of the final backup. + */ + finalBackupDescription?: string; + /** + * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. + */ + finalBackupExpiryTime?: string; + /** + * Optional. Retention period of the final backup. + */ + finalBackupTtlDays?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ @@ -6316,6 +6679,17 @@ export namespace sqladmin_v1 { */ project?: string; } + export interface Params$Resource$Instances$Listservercertificates + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Patch extends StandardParameters { /** * Cloud SQL instance ID. This does not include the project ID. @@ -6427,6 +6801,22 @@ export namespace sqladmin_v1 { */ requestBody?: Schema$InstancesRotateServerCaRequest; } + export interface Params$Resource$Instances$Rotateservercertificate + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesRotateServerCertificateRequest; + } export interface Params$Resource$Instances$Startreplica extends StandardParameters { /** @@ -6790,6 +7180,10 @@ export namespace sqladmin_v1 { project?: string; } export interface Params$Resource$Operations$List extends StandardParameters { + /** + * Optional. A filter string that follows the rules of EBNF grammar (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Cloud SQL provides filters for status, operationType, and startTime. + */ + filter?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 91549b4c01..c6930802fb 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -284,6 +284,10 @@ export namespace sqladmin_v1beta4 { * This is always `sql#backupContext`. */ kind?: string | null; + /** + * The name of the backup. Format: projects/{project\}/backups/{backup\} + */ + name?: string | null; } /** * Backup Reencryption Config @@ -1281,6 +1285,27 @@ export namespace sqladmin_v1beta4 { */ kind?: string | null; } + /** + * Instances ListServerCertificatess response. + */ + export interface Schema$InstancesListServerCertificatesResponse { + /** + * The `sha1_fingerprint` of the active certificate from `server_certs`. + */ + activeVersion?: string | null; + /** + * List of server CA certificates for the instance. + */ + caCerts?: Schema$SslCert[]; + /** + * This is always `sql#instancesListServerCertificates`. + */ + kind?: string | null; + /** + * List of server certificates for the instance, signed by the corresponding CA from the `ca_certs` list. + */ + serverCerts?: Schema$SslCert[]; + } /** * Database Instance reencrypt request. */ @@ -1294,10 +1319,18 @@ export namespace sqladmin_v1beta4 { * Database instance restore backup request. */ export interface Schema$InstancesRestoreBackupRequest { + /** + * The name of the backup to restore from in following format: projects/{project-id\}/backups/{backup-uid\} Only one of restore_backup_context or backup can be passed to the input. + */ + backup?: string | null; /** * Parameters required to perform the restore backup operation. */ restoreBackupContext?: Schema$RestoreBackupContext; + /** + * Optional. Restore instance settings overrides the instance settings stored as part of the backup. Instance's major database version cannot be changed and the disk size can only be increased. This feature is only available for restores to new instances using the backup name. + */ + restoreInstanceSettings?: Schema$DatabaseInstance; } /** * Rotate Server CA request. @@ -1308,6 +1341,15 @@ export namespace sqladmin_v1beta4 { */ rotateServerCaContext?: Schema$RotateServerCaContext; } + /** + * Rotate Server Certificate request. + */ + export interface Schema$InstancesRotateServerCertificateRequest { + /** + * Optional. Contains details about the rotate server CA operation. + */ + rotateServerCertificateContext?: Schema$RotateServerCertificateContext; + } /** * Instance truncate log request. */ @@ -1669,6 +1711,10 @@ export namespace sqladmin_v1beta4 { * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results. */ nextPageToken?: string | null; + /** + * List of warnings that occurred while handling the request. + */ + warnings?: Schema$ApiWarning[]; } /** * Read-only password status. @@ -1820,6 +1866,19 @@ export namespace sqladmin_v1beta4 { */ nextVersion?: string | null; } + /** + * Instance rotate server certificate context. + */ + export interface Schema$RotateServerCertificateContext { + /** + * Optional. This is always `sql#rotateServerCertificateContext`. + */ + kind?: string | null; + /** + * Optional. The fingerprint of the next version to be rotated to. If left unspecified, will be rotated to the most recently added server certificate version. + */ + nextVersion?: string | null; + } /** * Database instance settings. */ @@ -4024,6 +4083,96 @@ export namespace sqladmin_v1beta4 { } } + /** + * Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, please use AddServerCa 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. + */ + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: StreamMethodOptions + ): GaxiosPromise; + addServerCertificate( + params?: Params$Resource$Instances$Addservercertificate, + options?: MethodOptions + ): GaxiosPromise; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addServerCertificate( + params: Params$Resource$Instances$Addservercertificate, + callback: BodyResponseCallback + ): void; + addServerCertificate( + callback: BodyResponseCallback + ): void; + addServerCertificate( + paramsOrCallback?: + | Params$Resource$Instances$Addservercertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addservercertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addservercertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/addServerCertificate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. * @@ -4994,6 +5143,103 @@ export namespace sqladmin_v1beta4 { } } + /** + * Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: StreamMethodOptions + ): GaxiosPromise; + ListServerCertificates( + params?: Params$Resource$Instances$Listservercertificates, + options?: MethodOptions + ): GaxiosPromise; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + params: Params$Resource$Instances$Listservercertificates, + callback: BodyResponseCallback + ): void; + ListServerCertificates( + callback: BodyResponseCallback + ): void; + ListServerCertificates( + paramsOrCallback?: + | Params$Resource$Instances$Listservercertificates + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Listservercertificates; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Listservercertificates; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/listServerCertificates' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics. * @@ -5705,6 +5951,96 @@ export namespace sqladmin_v1beta4 { } } + /** + * Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, please use RotateServerCa 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. + */ + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: StreamMethodOptions + ): GaxiosPromise; + RotateServerCertificate( + params?: Params$Resource$Instances$Rotateservercertificate, + options?: MethodOptions + ): GaxiosPromise; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + params: Params$Resource$Instances$Rotateservercertificate, + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + callback: BodyResponseCallback + ): void; + RotateServerCertificate( + paramsOrCallback?: + | Params$Resource$Instances$Rotateservercertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Rotateservercertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Rotateservercertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCertificate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Starts the replication in the read replica instance. * @@ -6171,6 +6507,17 @@ export namespace sqladmin_v1beta4 { */ project?: string; } + export interface Params$Resource$Instances$Addservercertificate + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Clone extends StandardParameters { /** * The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID. @@ -6187,6 +6534,22 @@ export namespace sqladmin_v1beta4 { requestBody?: Schema$InstancesCloneRequest; } export interface Params$Resource$Instances$Delete extends StandardParameters { + /** + * Flag to opt-in for final backup. By default, it is turned off. + */ + enableFinalBackup?: boolean; + /** + * Optional. The description of the final backup. + */ + finalBackupDescription?: string; + /** + * Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired. + */ + finalBackupExpiryTime?: string; + /** + * Optional. Retention period of the final backup. + */ + finalBackupTtlDays?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ @@ -6323,6 +6686,17 @@ export namespace sqladmin_v1beta4 { */ project?: string; } + export interface Params$Resource$Instances$Listservercertificates + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Patch extends StandardParameters { /** * Cloud SQL instance ID. This does not include the project ID. @@ -6434,6 +6808,22 @@ export namespace sqladmin_v1beta4 { */ requestBody?: Schema$InstancesRotateServerCaRequest; } + export interface Params$Resource$Instances$Rotateservercertificate + extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstancesRotateServerCertificateRequest; + } export interface Params$Resource$Instances$Startreplica extends StandardParameters { /** @@ -6797,6 +7187,10 @@ export namespace sqladmin_v1beta4 { project?: string; } export interface Params$Resource$Operations$List extends StandardParameters { + /** + * Optional. A filter string that follows the rules of EBNF grammar (https://google.aip.dev/assets/misc/ebnf-filtering.txt). Cloud SQL provides filters for status, operationType, and startTime. + */ + filter?: string; /** * Cloud SQL instance ID. This does not include the project ID. */ diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 513edefeb5..b47650bac1 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -1058,6 +1058,10 @@ export namespace storage_v1 { * The owner of the object. This will always be the uploader of the object. */ owner?: {entity?: string; entityId?: string} | null; + /** + * Restore token used to differentiate deleted objects with the same name and generation. This field is only returned for deleted objects in hierarchical namespace buckets. + */ + restoreToken?: string | null; /** * A collection of object level retention parameters. */ @@ -1234,6 +1238,23 @@ export namespace storage_v1 { */ version?: number | null; } + /** + * A Relocate Bucket request. + */ + export interface Schema$RelocateBucketRequest { + /** + * The bucket's new custom placement configuration if relocating to a Custom Dual Region. + */ + destinationCustomPlacementConfig?: {dataLocations?: string[]} | null; + /** + * The new location the bucket will be relocated to. + */ + destinationLocation?: string | null; + /** + * If true, validate the operation, but do not actually relocate the bucket. + */ + validateOnly?: boolean | null; + } /** * A rewrite response. */ @@ -3384,6 +3405,100 @@ export namespace storage_v1 { } } + /** + * Initiates a long-running Relocate Bucket operation on the specified 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. + */ + relocate( + params: Params$Resource$Buckets$Relocate, + options: StreamMethodOptions + ): GaxiosPromise; + relocate( + params?: Params$Resource$Buckets$Relocate, + options?: MethodOptions + ): GaxiosPromise; + relocate( + params: Params$Resource$Buckets$Relocate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + relocate( + params: Params$Resource$Buckets$Relocate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + relocate( + params: Params$Resource$Buckets$Relocate, + callback: BodyResponseCallback + ): void; + relocate( + callback: BodyResponseCallback + ): void; + relocate( + paramsOrCallback?: + | Params$Resource$Buckets$Relocate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Buckets$Relocate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buckets$Relocate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/storage/v1/b/{bucket}/relocate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['bucket'], + pathParams: ['bucket'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Restores a soft-deleted bucket. * @@ -3924,6 +4039,17 @@ export namespace storage_v1 { */ requestBody?: Schema$Bucket; } + export interface Params$Resource$Buckets$Relocate extends StandardParameters { + /** + * Name of the bucket to be moved. + */ + bucket?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RelocateBucketRequest; + } export interface Params$Resource$Buckets$Restore extends StandardParameters { /** * Name of a bucket. @@ -8709,6 +8835,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to noAcl. */ projection?: string; + /** + * Restore token used to differentiate soft-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets and if softDeleted is set to true. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation. + */ + restoreToken?: string; /** * If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */ @@ -8949,6 +9079,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to full. */ projection?: string; + /** + * Restore token used to differentiate sof-deleted objects with the same name and generation. Only applicable for hierarchical namespace buckets. This parameter is optional, and is only required in the rare case when there are multiple soft-deleted objects with the same name and generation. + */ + restoreToken?: string; /** * The project to be billed for this request. Required for Requester Pays buckets. */ diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 51cbb8e88b..67e5195592 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -569,23 +569,23 @@ export namespace storagetransfer_v1 { rootDirectory?: string | null; } /** - * Specifies the configuration for running a replication job. + * Specifies the configuration for a cross-bucket replication job. Cross-bucket replication copies new or updated objects from a source Cloud Storage bucket to a destination Cloud Storage bucket. Existing objects in the source bucket are not copied by a new cross-bucket replication job. */ export interface Schema$ReplicationSpec { /** - * Specifies cloud Storage data sink. + * The Cloud Storage bucket to which to replicate objects. */ gcsDataSink?: Schema$GcsData; /** - * Specifies cloud Storage data source. + * The Cloud Storage bucket from which to replicate objects. */ gcsDataSource?: Schema$GcsData; /** - * Specifies the object conditions to only include objects that satisfy these conditions in the set of data source objects. Object conditions based on objects' "last modification time" do not exclude objects in a data sink. + * Object conditions that determine which objects are transferred. For replication jobs, only `include_prefixes` and `exclude_prefixes` are supported. */ objectConditions?: Schema$ObjectConditions; /** - * Specifies the actions to be performed on the object during replication. Delete options are not supported for replication and when specified, the request fails with an INVALID_ARGUMENT error. + * Specifies the metadata options to be applied during replication. Delete options are not supported. If a delete option is specified, the request fails with an INVALID_ARGUMENT error. */ transferOptions?: Schema$TransferOptions; } @@ -2191,7 +2191,7 @@ export namespace storagetransfer_v1 { export interface Params$Resource$Transferjobs$List extends StandardParameters { /** - * Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...]\}` Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `projectId` is required. `jobNames` and `jobStatuses` are optional. The valid values for `jobStatuses` are case-insensitive: ENABLED, DISABLED, and DELETED. + * Required. A list of query parameters specified as JSON text in the form of: ``` { "projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "jobStatuses":["status1","status2",...], "dataBackend":"QUERY_REPLICATION_CONFIGS", "sourceBucket":"source-bucket-name", "sinkBucket":"sink-bucket-name", \} ``` The JSON formatting in the example is for display only; provide the query parameters without spaces or line breaks. * `projectId` is required. * Since `jobNames` and `jobStatuses` support multiple values, their values must be specified with array notation. `jobNames` and `jobStatuses` are optional. Valid values are case-insensitive: * ENABLED * DISABLED * DELETED * Specify `"dataBackend":"QUERY_REPLICATION_CONFIGS"` to return a list of cross-bucket replication jobs. * Limit the results to jobs from a particular bucket with `sourceBucket` and/or to a particular bucket with `sinkBucket`. */ filter?: string; /** diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index 15a886a274..9b1d2be2a7 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -223,7 +223,7 @@ export namespace sts_v1 { */ options?: string | null; /** - * Required. An identifier for the type of requested security token. Can be `urn:ietf:params:oauth:token-type:access_token` or `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. + * Required. An identifier for the type of requested security token. Can be `urn:ietf:params:oauth:token-type:access_token` or `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`. */ requestedTokenType?: string | null; /** @@ -244,7 +244,7 @@ export namespace sts_v1 { */ export interface Schema$GoogleIdentityStsV1ExchangeTokenResponse { /** - * The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. + * The access boundary session key. This key is used along with the access boundary intermediary token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediary_token`. */ access_boundary_session_key?: string | null; /** diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 485764597a..df61d8a98f 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -274,6 +274,10 @@ export namespace testing_v1 { * The unique opaque id for this model. Use this for invoking the TestExecutionService. */ id?: string | null; + /** + * Output only. Lab info of this device. + */ + labInfo?: Schema$LabInfo; /** * True if and only if tests with this model are recorded by stitching together screenshots. See use_low_spec_video_recording in device config. */ @@ -1005,6 +1009,15 @@ export namespace testing_v1 { */ xctestrun?: Schema$FileReference; } + /** + * Lab specific information for a device. + */ + export interface Schema$LabInfo { + /** + * Lab name where the device is hosted. If empty, the device is hosted in a Google owned lab. + */ + name?: string | null; + } /** * Specifies an intent that starts the main launcher activity. */ diff --git a/src/apis/texttospeech/v1.ts b/src/apis/texttospeech/v1.ts index 9113f912e4..da8fc231db 100644 --- a/src/apis/texttospeech/v1.ts +++ b/src/apis/texttospeech/v1.ts @@ -130,6 +130,15 @@ export namespace texttospeech_v1 { } } + /** + * Used for advanced voice options. + */ + export interface Schema$AdvancedVoiceOptions { + /** + * Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency. + */ + lowLatencyJourneySynthesis?: boolean | null; + } /** * Description of audio data to be synthesized. */ @@ -163,6 +172,32 @@ export namespace texttospeech_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * Pronunciation customization for a phrase. + */ + export interface Schema$CustomPronunciationParams { + /** + * The phonetic encoding of the phrase. + */ + phoneticEncoding?: string | null; + /** + * The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence. + */ + phrase?: string | null; + /** + * The pronunciation of the phrase. This must be in the phonetic encoding specified above. + */ + pronunciation?: string | null; + } + /** + * A collection of pronunciation customizations. + */ + export interface Schema$CustomPronunciations { + /** + * The pronunciation customizations to be applied. + */ + pronunciations?: Schema$CustomPronunciationParams[]; + } /** * Description of the custom voice to be synthesized. */ @@ -180,6 +215,36 @@ export namespace texttospeech_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 {} + /** + * Request message for the `GenerateVoiceCloningKey` method. + */ + export interface Schema$GenerateVoiceCloningKeyRequest { + /** + * Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field. + */ + consentScript?: string | null; + /** + * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. + */ + languageCode?: string | null; + /** + * Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected. + */ + referenceAudio?: Schema$InputAudio; + /** + * Required. The voice talent audio used to verify consent to voice clone. + */ + voiceTalentConsent?: Schema$InputAudio; + } + /** + * Response message for the `GenerateVoiceCloningKey` method. + */ + export interface Schema$GenerateVoiceCloningKeyResponse { + /** + * The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key]. + */ + voiceCloningKey?: string | null; + } /** * Metadata for response returned by the `SynthesizeLongAudio` method. */ @@ -197,6 +262,32 @@ export namespace texttospeech_v1 { */ startTime?: string | null; } + /** + * Holds audio content and config. + */ + export interface Schema$InputAudio { + /** + * Required. Provides information that specifies how to process content. + */ + audioConfig?: Schema$InputAudioConfig; + /** + * Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length. + */ + content?: string | null; + } + /** + * Description of inputted audio data. + */ + export interface Schema$InputAudioConfig { + /** + * Required. The format of the audio byte stream. + */ + audioEncoding?: string | null; + /** + * Required. The sample rate (in hertz) for this audio. + */ + sampleRateHertz?: number | null; + } /** * The response message for Operations.ListOperations. */ @@ -265,6 +356,10 @@ export namespace texttospeech_v1 { * Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. */ export interface Schema$SynthesisInput { + /** + * Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. 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 (entirely or partially). + */ + customPronunciations?: Schema$CustomPronunciations; /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). */ @@ -316,6 +411,10 @@ export namespace texttospeech_v1 { * The top-level message sent by the client for the `SynthesizeSpeech` method. */ export interface Schema$SynthesizeSpeechRequest { + /** + * Adnanced voice options. + */ + advancedVoiceOptions?: Schema$AdvancedVoiceOptions; /** * Required. The configuration of the synthesized audio. */ @@ -359,6 +458,15 @@ export namespace texttospeech_v1 { */ ssmlGender?: string | null; } + /** + * The configuration of Voice Clone feature. + */ + export interface Schema$VoiceCloneParams { + /** + * Required. Created by GenerateVoiceCloningKey. + */ + voiceCloningKey?: string | null; + } /** * Description of which voice to use for a synthesis request. */ @@ -379,6 +487,10 @@ export namespace texttospeech_v1 { * The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string | null; + /** + * Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration. + */ + voiceClone?: Schema$VoiceCloneParams; } export class Resource$Operations { @@ -1025,6 +1137,103 @@ export namespace texttospeech_v1 { this.context = context; } + /** + * Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: StreamMethodOptions + ): GaxiosPromise; + generateVoiceCloningKey( + params?: Params$Resource$Voices$Generatevoicecloningkey, + options?: MethodOptions + ): GaxiosPromise; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + paramsOrCallback?: + | Params$Resource$Voices$Generatevoicecloningkey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Voices$Generatevoicecloningkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Voices$Generatevoicecloningkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://texttospeech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/voices:generateVoiceCloningKey').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Returns a list of Voice supported for synthesis. * @@ -1113,6 +1322,13 @@ export namespace texttospeech_v1 { } } + export interface Params$Resource$Voices$Generatevoicecloningkey + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$GenerateVoiceCloningKeyRequest; + } export interface Params$Resource$Voices$List extends StandardParameters { /** * Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be returned. diff --git a/src/apis/texttospeech/v1beta1.ts b/src/apis/texttospeech/v1beta1.ts index 13718030c6..bf9c5b023a 100644 --- a/src/apis/texttospeech/v1beta1.ts +++ b/src/apis/texttospeech/v1beta1.ts @@ -128,6 +128,15 @@ export namespace texttospeech_v1beta1 { } } + /** + * Used for advanced voice options. + */ + export interface Schema$AdvancedVoiceOptions { + /** + * Only for Jounrney voices. If false, the synthesis will be context aware and have higher latency. + */ + lowLatencyJourneySynthesis?: boolean | null; + } /** * Description of audio data to be synthesized. */ @@ -157,6 +166,32 @@ export namespace texttospeech_v1beta1 { */ volumeGainDb?: number | null; } + /** + * Pronunciation customization for a phrase. + */ + export interface Schema$CustomPronunciationParams { + /** + * The phonetic encoding of the phrase. + */ + phoneticEncoding?: string | null; + /** + * The phrase to which the customization will be applied. The phrase can be multiple words (in the case of proper nouns etc), but should not span to a whole sentence. + */ + phrase?: string | null; + /** + * The pronunciation of the phrase. This must be in the phonetic encoding specified above. + */ + pronunciation?: string | null; + } + /** + * A collection of pronunciation customizations. + */ + export interface Schema$CustomPronunciations { + /** + * The pronunciation customizations to be applied. + */ + pronunciations?: Schema$CustomPronunciationParams[]; + } /** * Description of the custom voice to be synthesized. */ @@ -170,6 +205,36 @@ export namespace texttospeech_v1beta1 { */ reportedUsage?: string | null; } + /** + * Request message for the `GenerateVoiceCloningKey` method. + */ + export interface Schema$GenerateVoiceCloningKeyRequest { + /** + * Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field. + */ + consentScript?: string | null; + /** + * Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes. + */ + languageCode?: string | null; + /** + * Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected. + */ + referenceAudio?: Schema$InputAudio; + /** + * Required. The voice talent audio used to verify consent to voice clone. + */ + voiceTalentConsent?: Schema$InputAudio; + } + /** + * Response message for the `GenerateVoiceCloningKey` method. + */ + export interface Schema$GenerateVoiceCloningKeyResponse { + /** + * The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key]. + */ + voiceCloningKey?: string | null; + } /** * Metadata for response returned by the `SynthesizeLongAudio` method. */ @@ -187,6 +252,32 @@ export namespace texttospeech_v1beta1 { */ startTime?: string | null; } + /** + * Holds audio content and config. + */ + export interface Schema$InputAudio { + /** + * Required. Provides information that specifies how to process content. + */ + audioConfig?: Schema$InputAudioConfig; + /** + * Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length. + */ + content?: string | null; + } + /** + * Description of inputted audio data. + */ + export interface Schema$InputAudioConfig { + /** + * Required. The format of the audio byte stream. + */ + audioEncoding?: string | null; + /** + * Required. The sample rate (in hertz) for this audio. + */ + sampleRateHertz?: number | null; + } /** * The response message for Operations.ListOperations. */ @@ -255,6 +346,10 @@ export namespace texttospeech_v1beta1 { * Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 bytes. */ export interface Schema$SynthesisInput { + /** + * Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations. The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet. 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 (entirely or partially). + */ + customPronunciations?: Schema$CustomPronunciations; /** * The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml). */ @@ -306,6 +401,10 @@ export namespace texttospeech_v1beta1 { * The top-level message sent by the client for the `SynthesizeSpeech` method. */ export interface Schema$SynthesizeSpeechRequest { + /** + * Adnanced voice options. + */ + advancedVoiceOptions?: Schema$AdvancedVoiceOptions; /** * Required. The configuration of the synthesized audio. */ @@ -374,6 +473,15 @@ export namespace texttospeech_v1beta1 { */ ssmlGender?: string | null; } + /** + * The configuration of Voice Clone feature. + */ + export interface Schema$VoiceCloneParams { + /** + * Required. Created by GenerateVoiceCloningKey. + */ + voiceCloningKey?: string | null; + } /** * Description of which voice to use for a synthesis request. */ @@ -394,6 +502,10 @@ export namespace texttospeech_v1beta1 { * The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ ssmlGender?: string | null; + /** + * Optional. The configuration for a voice clone. If [VoiceCloneParams.voice_clone_key] is set, the service will choose the voice clone matching the specified configuration. + */ + voiceClone?: Schema$VoiceCloneParams; } export class Resource$Projects { @@ -843,6 +955,103 @@ export namespace texttospeech_v1beta1 { this.context = context; } + /** + * Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: StreamMethodOptions + ): GaxiosPromise; + generateVoiceCloningKey( + params?: Params$Resource$Voices$Generatevoicecloningkey, + options?: MethodOptions + ): GaxiosPromise; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + params: Params$Resource$Voices$Generatevoicecloningkey, + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + callback: BodyResponseCallback + ): void; + generateVoiceCloningKey( + paramsOrCallback?: + | Params$Resource$Voices$Generatevoicecloningkey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Voices$Generatevoicecloningkey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Voices$Generatevoicecloningkey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://texttospeech.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/voices:generateVoiceCloningKey').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Returns a list of Voice supported for synthesis. * @@ -931,6 +1140,13 @@ export namespace texttospeech_v1beta1 { } } + export interface Params$Resource$Voices$Generatevoicecloningkey + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$GenerateVoiceCloningKeyRequest; + } export interface Params$Resource$Voices$List extends StandardParameters { /** * Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify `"en-NZ"`, all `"en-NZ"` voices will be returned. If you specify `"no"`, both `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be returned. diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index 668bd9faab..dc5666fe18 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -590,6 +590,10 @@ export namespace tpu_v2alpha1 { * Network configurations for the TPU node. */ networkConfig?: Schema$NetworkConfig; + /** + * Optional. Repeated network configurations for the TPU node. + */ + networkConfigs?: Schema$NetworkConfig[]; /** * Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first. */ diff --git a/src/apis/vision/v1.ts b/src/apis/vision/v1.ts index e77d96c62f..a46f731821 100644 --- a/src/apis/vision/v1.ts +++ b/src/apis/vision/v1.ts @@ -1008,7 +1008,7 @@ export namespace vision_v1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark { /** @@ -1870,7 +1870,7 @@ export namespace vision_v1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { /** @@ -2749,7 +2749,7 @@ export namespace vision_v1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark { /** @@ -3697,7 +3697,7 @@ export namespace vision_v1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** @@ -4470,7 +4470,7 @@ export namespace vision_v1 { value?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$Landmark { /** diff --git a/src/apis/vision/v1p1beta1.ts b/src/apis/vision/v1p1beta1.ts index 092a462f33..cf03950f8c 100644 --- a/src/apis/vision/v1p1beta1.ts +++ b/src/apis/vision/v1p1beta1.ts @@ -979,7 +979,7 @@ export namespace vision_v1p1beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark { /** @@ -1969,7 +1969,7 @@ export namespace vision_v1p1beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { /** @@ -2848,7 +2848,7 @@ export namespace vision_v1p1beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark { /** @@ -3796,7 +3796,7 @@ export namespace vision_v1p1beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** @@ -4487,7 +4487,7 @@ export namespace vision_v1p1beta1 { value?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$Landmark { /** diff --git a/src/apis/vision/v1p2beta1.ts b/src/apis/vision/v1p2beta1.ts index f261e09db3..6d7531f428 100644 --- a/src/apis/vision/v1p2beta1.ts +++ b/src/apis/vision/v1p2beta1.ts @@ -821,7 +821,7 @@ export namespace vision_v1p2beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p1beta1FaceAnnotationLandmark { /** @@ -1841,7 +1841,7 @@ export namespace vision_v1p2beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p2beta1FaceAnnotationLandmark { /** @@ -2848,7 +2848,7 @@ export namespace vision_v1p2beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p3beta1FaceAnnotationLandmark { /** @@ -3796,7 +3796,7 @@ export namespace vision_v1p2beta1 { underExposedLikelihood?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$GoogleCloudVisionV1p4beta1FaceAnnotationLandmark { /** @@ -4487,7 +4487,7 @@ export namespace vision_v1p2beta1 { value?: string | null; } /** - * A face-specific landmark (for example, a face feature). + * A face-specific landmark (for example, a face feature). Landmark positions may fall outside the bounds of the image if the face is near one or more edges of the image. Therefore it is NOT guaranteed that `0 <= x < width` or `0 <= y < height`. */ export interface Schema$Landmark { /** diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index f30dbc1adc..eb463fe47c 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -3999,11 +3999,11 @@ export namespace vmmigration_v1 { export interface Params$Resource$Projects$Locations$Imageimports$List extends StandardParameters { /** - * Optional. The filter request (according to https://google.aip.dev/160). + * Optional. The filter request (according to AIP-160). */ filter?: string; /** - * Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field. + * Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. */ orderBy?: string; /** @@ -4317,11 +4317,11 @@ export namespace vmmigration_v1 { export interface Params$Resource$Projects$Locations$Imageimports$Imageimportjobs$List extends StandardParameters { /** - * Optional. The filter request (according to https://google.aip.dev/160). + * Optional. The filter request (according to AIP-160). */ filter?: string; /** - * Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field. + * Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. */ orderBy?: string; /** diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 643b46c10b..31cf7805aa 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -4165,11 +4165,11 @@ export namespace vmmigration_v1alpha1 { export interface Params$Resource$Projects$Locations$Imageimports$List extends StandardParameters { /** - * Optional. The filter request (according to https://google.aip.dev/160). + * Optional. The filter request (according to AIP-160). */ filter?: string; /** - * Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field. + * Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. */ orderBy?: string; /** @@ -4486,11 +4486,11 @@ export namespace vmmigration_v1alpha1 { export interface Params$Resource$Projects$Locations$Imageimports$Imageimportjobs$List extends StandardParameters { /** - * Optional. The filter request (according to https://google.aip.dev/160). + * Optional. The filter request (according to AIP-160). */ filter?: string; /** - * Optional. The order by fields for the result (according to https://google.aip.dev/132#ordering). Currently ordering is only possible by "name" field. + * Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. */ orderBy?: string; /** diff --git a/src/apis/vpcaccess/v1.ts b/src/apis/vpcaccess/v1.ts index 6707b607b7..9ef77d89b9 100644 --- a/src/apis/vpcaccess/v1.ts +++ b/src/apis/vpcaccess/v1.ts @@ -133,7 +133,7 @@ export namespace vpcaccess_v1 { */ connectedProjects?: string[] | null; /** - * The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. + * Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. */ ipCidrRange?: string | null; /** @@ -161,7 +161,7 @@ export namespace vpcaccess_v1 { */ name?: string | null; /** - * Name of a VPC network. + * Optional. Name of a VPC network. */ network?: string | null; /** @@ -169,7 +169,7 @@ export namespace vpcaccess_v1 { */ state?: string | null; /** - * The subnet in which to house the VPC Access Connector. + * Optional. The subnet in which to house the VPC Access Connector. */ subnet?: Schema$Subnet; } @@ -347,11 +347,11 @@ export namespace vpcaccess_v1 { */ export interface Schema$Subnet { /** - * Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/subnetworks/{subnetName\} the correct input for this field would be {subnetName\} + * Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/subnetworks/{subnetName\} the correct input for this field would be {subnetName\} */ name?: string | null; /** - * Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued. + * Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued. */ projectId?: string | null; } diff --git a/src/apis/vpcaccess/v1beta1.ts b/src/apis/vpcaccess/v1beta1.ts index 62f99a5c09..a1df1632bb 100644 --- a/src/apis/vpcaccess/v1beta1.ts +++ b/src/apis/vpcaccess/v1beta1.ts @@ -137,7 +137,7 @@ export namespace vpcaccess_v1beta1 { */ createTime?: string | null; /** - * The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. + * Optional. The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. */ ipCidrRange?: string | null; /** @@ -169,7 +169,7 @@ export namespace vpcaccess_v1beta1 { */ name?: string | null; /** - * Name of a VPC network. + * Optional. Name of a VPC network. */ network?: string | null; /** @@ -177,7 +177,7 @@ export namespace vpcaccess_v1beta1 { */ state?: string | null; /** - * The subnet in which to house the VPC Access Connector. + * Optional. The subnet in which to house the VPC Access Connector. */ subnet?: Schema$Subnet; } @@ -355,11 +355,11 @@ export namespace vpcaccess_v1beta1 { */ export interface Schema$Subnet { /** - * Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/subnetworks/{subnetName\} the correct input for this field would be {subnetName\} + * Optional. Subnet name (relative, not fully qualified). E.g. if the full subnet selfLink is https://compute.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/subnetworks/{subnetName\} the correct input for this field would be {subnetName\} */ name?: string | null; /** - * Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued. + * Optional. Project in which the subnet exists. If not set, this project is assumed to be the project for which the connector create request was issued. */ projectId?: string | null; } diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index 9c44d497f5..e9e6a35d0b 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -905,6 +905,10 @@ export namespace walletobjects_v1 { * Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. */ textModulesData?: Schema$TextModuleData[]; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Event venue details. */ @@ -1071,6 +1075,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -1319,6 +1327,10 @@ export namespace walletobjects_v1 { * Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. */ textModulesData?: Schema$TextModuleData[]; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -1491,6 +1503,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -1578,6 +1594,10 @@ export namespace walletobjects_v1 { * Text module data. If `textModulesData` is also defined on the object, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object. */ textModulesData?: Schema$TextModuleData[]; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * View Unlock Requirement options for the generic pass. */ @@ -1709,6 +1729,10 @@ export namespace walletobjects_v1 { * The time period this object will be considered valid or usable. When the time period is passed, the object will be considered expired, which will affect the rendering on user's devices. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * The wide logo of the pass. When provided, this will be used in place of the logo in the top left of the card view. */ @@ -1873,6 +1897,10 @@ export namespace walletobjects_v1 { * Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. */ textModulesData?: Schema$TextModuleData[]; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -2023,6 +2051,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -2416,6 +2448,10 @@ export namespace walletobjects_v1 { * Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. */ textModulesData?: Schema$TextModuleData[]; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -2566,6 +2602,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -2838,6 +2878,15 @@ export namespace walletobjects_v1 { */ linkedOfferObjectIds?: Schema$ModifyLinkedOfferObjects; } + /** + * Constraints that all must be met for the module to be shown. + */ + export interface Schema$ModuleViewConstraints { + /** + * The period of time that the module will be displayed to users. Can define both a `startTime` and `endTime`. The module is displayed immediately after insertion unless a `startTime` is set. The module is displayed indefinitely if `endTime` is not set. + */ + displayInterval?: Schema$TimeInterval; + } export interface Schema$Money { /** * The currency code, such as "USD" or "EUR." @@ -3031,6 +3080,10 @@ export namespace walletobjects_v1 { * The title image of the offer. This image is displayed in both the details and list views of the app. */ titleImage?: Schema$Image; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -3161,6 +3214,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -3814,6 +3871,10 @@ export namespace walletobjects_v1 { * Required. The type of transit this class represents, such as "bus". */ transitType?: string | null; + /** + * Optional value added module data. Maximum of ten on the class. For a pass only ten will be displayed, prioritizing those from the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -4008,6 +4069,10 @@ export namespace walletobjects_v1 { * The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. */ validTimeInterval?: Schema$TimeInterval; + /** + * Optional value added module data. Maximum of ten on the object. + */ + valueAddedModuleData?: Schema$ValueAddedModuleData[]; /** * Deprecated */ @@ -4091,6 +4156,35 @@ export namespace walletobjects_v1 { */ uri?: string | null; } + /** + * Data for Value Added module. Required fields are header and uri. + */ + export interface Schema$ValueAddedModuleData { + /** + * Body to be displayed on the module. Character limit is 50 and longer strings will be truncated. + */ + body?: Schema$LocalizedString; + /** + * Header to be displayed on the module. Character limit is 60 and longer strings will be truncated. + */ + header?: Schema$LocalizedString; + /** + * Image to be displayed on the module. Recommended image ratio is 1:1. Images will be resized to fit this ratio. + */ + image?: Schema$Image; + /** + * The index for sorting the modules. Modules with a lower sort index are shown before modules with a higher sort index. If unspecified, the sort index is assumed to be INT_MAX. For two modules with the same index, the sorting behavior is undefined. + */ + sortIndex?: number | null; + /** + * URI that the module leads to on click. This can be a web link or a deep link as mentioned in https://developer.android.com/training/app-links/deep-linking. + */ + uri?: string | null; + /** + * Constraints that all must be met for the module to be shown. + */ + viewConstraints?: Schema$ModuleViewConstraints; + } export class Resource$Eventticketclass { context: APIRequestContext; diff --git a/src/apis/workflowexecutions/v1.ts b/src/apis/workflowexecutions/v1.ts index 4d43570cb8..9d3e76c010 100644 --- a/src/apis/workflowexecutions/v1.ts +++ b/src/apis/workflowexecutions/v1.ts @@ -232,7 +232,7 @@ export namespace workflowexecutions_v1 { */ result?: string | null; /** - * Output only. Marks the beginning of execution. + * Output only. Marks the beginning of execution. Note that this will be the same as `createTime` for executions that start immediately. */ startTime?: string | null; /** @@ -1283,7 +1283,7 @@ export namespace workflowexecutions_v1 { export interface Params$Resource$Projects$Locations$Workflows$Executions$List extends StandardParameters { /** - * Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime\>"2023-08-01" AND state="FAILED"` + * Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `createTime`, `startTime`, `endTime`, `duration`, `workflowRevisionId`, `stepName`, `label`, and `disableConcurrencyQuotaOverflowBuffering`. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `startTime\>"2023-08-01" AND state="FAILED"` */ filter?: string; /** diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index eb98b4a6cf..ac70f106d3 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -290,7 +290,7 @@ export namespace workflows_v1 { message?: string | null; } /** - * LINT.IfChange Workflow program to be executed by Workflows. + * Workflow program to be executed by Workflows. */ export interface Schema$Workflow { /** diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 28bd9e1d02..a5096cb444 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -973,7 +973,7 @@ export namespace workstations_v1 { */ displayName?: string | null; /** - * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" + * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" */ enableAuditAgent?: boolean | null; /** @@ -1005,7 +1005,7 @@ export namespace workstations_v1 { */ labels?: {[key: string]: string} | null; /** - * Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. + * Optional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited. */ maxUsableWorkstations?: number | null; /** diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index 378a8dd794..94d1ed4dde 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -197,7 +197,7 @@ export namespace workstations_v1beta { */ enableNestedVirtualization?: boolean | null; /** - * Optional. Required. The id to be used for the boost config. + * Optional. Required. The id to be used for the boost configuration. */ id?: string | null; /** @@ -811,7 +811,7 @@ export namespace workstations_v1beta { */ annotations?: {[key: string]: string} | null; /** - * Output only. List of available boost configuration ids that this workstation can be boosted up to + * Output only. List of available boost configuration IDs that this workstation can be boosted up to. */ boostConfigs?: Schema$WorkstationBoostConfig[]; /** @@ -884,11 +884,11 @@ export namespace workstations_v1beta { updateTime?: string | null; } /** - * Boost config for this workstation. This object is populated from the parent workstation config. + * Boost configuration for this workstation. This object is populated from the parent workstation configuration. */ export interface Schema$WorkstationBoostConfig { /** - * Output only. Boost config id. + * Output only. Boost configuration ID. */ id?: string | null; } @@ -1014,7 +1014,7 @@ export namespace workstations_v1beta { */ displayName?: string | null; /** - * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" + * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](https://cloud.google.com/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" */ enableAuditAgent?: boolean | null; /** @@ -1050,7 +1050,7 @@ export namespace workstations_v1beta { */ labels?: {[key: string]: string} | null; /** - * Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. + * Optional. Maximum number of workstations under this configuration a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified, defaults to `0`, which indicates unlimited. */ maxUsableWorkstations?: number | null; /** diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 2ffcc0418e..bbbc613a33 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -3573,10 +3573,6 @@ export namespace youtube_v3 { * The ID that YouTube uses to uniquely identify the subscriber's channel. */ channelId?: string | null; - /** - * Channel title for the channel that the subscription belongs to. - */ - channelTitle?: string | null; /** * The subscription's details. */ @@ -3894,6 +3890,7 @@ export namespace youtube_v3 { * The monetizationDetails object encapsulates information about the monetization status of the video. */ monetizationDetails?: Schema$VideoMonetizationDetails; + paidProductPlacementDetails?: Schema$VideoPaidProductPlacementDetails; /** * The player object contains information that you would use to play the video in an embedded player. */ @@ -4365,6 +4362,15 @@ export namespace youtube_v3 { */ access?: Schema$AccessPolicy; } + /** + * Details about paid content, such as paid product placement, sponsorships or endorsement, contained in a YouTube video and a method to inform viewers of paid promotion. This data can only be retrieved by the video owner. + */ + export interface Schema$VideoPaidProductPlacementDetails { + /** + * This boolean represents whether the video contains Paid Product Placement, Studio equivalent: https://screenshot.googleplex.com/4Me79DE6AfT2ktp.png + */ + hasPaidProductPlacement?: boolean | null; + } /** * Player to be used for a video playback. */ @@ -4546,7 +4552,7 @@ export namespace youtube_v3 { viewCount?: string | null; } /** - * Basic details about a video category, such as its localized title. Next Id: 18 + * Basic details about a video category, such as its localized title. Next Id: 19 */ export interface Schema$VideoStatus { /** diff --git a/src/index.ts b/src/index.ts index 3ee59b4fa1..902c620ad8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -267,6 +267,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_v1beta} from './apis/firebasedataconnect/v1beta'; export {firebasedynamiclinks_v1} from './apis/firebasedynamiclinks/v1'; export {firebasehosting_v1} from './apis/firebasehosting/v1'; export {firebasehosting_v1beta1} from './apis/firebasehosting/v1beta1'; @@ -383,6 +384,7 @@ export {notebooks_v2} from './apis/notebooks/v2'; export {oauth2_v2} from './apis/oauth2/v2'; export {ondemandscanning_v1} from './apis/ondemandscanning/v1'; export {ondemandscanning_v1beta1} from './apis/ondemandscanning/v1beta1'; +export {oracledatabase_v1} from './apis/oracledatabase/v1'; export {orgpolicy_v2} from './apis/orgpolicy/v2'; export {osconfig_v1} from './apis/osconfig/v1'; export {osconfig_v1alpha} from './apis/osconfig/v1alpha';