OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

update all APIs

Browse Source 
Like documented in the README

```
rm -f .api.deps .cli.deps && FETCH_APIS=1 make update-json -j8
```
This commit is contained in:
Sebastian Thiel
2024-03-05 18:54:36 +01:00
parent 8a12e9d47e
commit ca974aa0a5
347 changed files with 202580 additions and 50157 deletions
Download Patch File Download Diff File Expand all files Collapse all files

307
etc/api/metastore/v1alpha/metastore-api.json
View File

@@ -448,6 +448,34 @@
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "metastore.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": "v1alpha/{+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": "v1alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
@@ -499,7 +527,7 @@
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"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}/operations",
"httpMethod": "GET",
"id": "metastore.projects.locations.operations.list",
@@ -571,6 +599,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"alterTableProperties": {
"description": "Alter metadata table properties.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties",
"httpMethod": "POST",
"id": "metastore.projects.locations.services.alterTableProperties",
"parameterOrder": [
"service"
],
"parameters": {
"service": {
"description": "Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1alpha/{+service}:alterTableProperties",
"request": {
"$ref": "AlterTablePropertiesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a metastore service in a project and location.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services",
@@ -1543,6 +1599,40 @@
]
}
}
},
"migrationExecutions": {
"methods": {
"delete": {
"description": "Deletes a single migration execution.",
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}",
"httpMethod": "DELETE",
"id": "metastore.projects.locations.services.migrationExecutions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.",
"location": "query",
"type": "string"
}
},
"path": "v1alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
@@ -1551,7 +1641,7 @@
}
}
},
"revision": "20230111",
"revision": "20240228",
"rootUrl": "https://metastore.googleapis.com/",
"schemas": {
"AlterMetadataResourceLocationRequest": {
@@ -1575,6 +1665,29 @@
"properties": {},
"type": "object"
},
"AlterTablePropertiesRequest": {
"description": "Request message for DataprocMetastore.AlterTableProperties.",
"id": "AlterTablePropertiesRequest",
"properties": {
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask",
"type": "object"
},
"tableName": {
"description": "Required. The name of the table containing the properties you're altering in the following format.databases/{database_id}/tables/{table_id}",
"type": "string"
},
"updateMask": {
"description": "A field mask that specifies the metadata table properties that are overwritten by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: \"properties.b\", \"properties.c\"then the result will be: properties { a: 1 b: 3 c: 4 } ",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "AuditConfig",
@@ -1654,11 +1767,13 @@
"description": "The type of the backend metastore.",
"enum": [
"METASTORE_TYPE_UNSPECIFIED",
"DATAPLEX",
"BIGQUERY",
"DATAPROC_METASTORE"
],
"enumDescriptions": [
"The metastore type is not set.",
"The backend metastore is Dataplex.",
"The backend metastore is BigQuery.",
"The backend metastore is Dataproc Metastore."
],
@@ -1741,23 +1856,34 @@
"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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
"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.",
"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",
"properties": {},
"type": "object"
},
"Consumer": {
"description": "Contains information of the customer's network configurations.",
"id": "Consumer",
"properties": {
"endpointLocation": {
"description": "Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.",
"readOnly": true,
"type": "string"
},
"endpointUri": {
"description": "Output only. The URI of the endpoint used to access the metastore service.",
"readOnly": true,
@@ -1775,7 +1901,7 @@
"id": "DataCatalogConfig",
"properties": {
"enabled": {
"description": "Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.",
"description": "Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.",
"type": "boolean"
}
},
@@ -1786,6 +1912,7 @@
"id": "DatabaseDump",
"properties": {
"databaseType": {
"deprecated": true,
"description": "The type of the database.",
"enum": [
"DATABASE_TYPE_UNSPECIFIED",
@@ -1802,6 +1929,7 @@
"type": "string"
},
"sourceDatabase": {
"deprecated": true,
"description": "The name of the source database.",
"type": "string"
},
@@ -1853,6 +1981,20 @@
},
"type": "object"
},
"ErrorDetails": {
"description": "Error details in public error message for DataprocMetastore.QueryMetadata.",
"id": "ErrorDetails",
"properties": {
"details": {
"additionalProperties": {
"type": "string"
},
"description": "Additional structured details about this error.Keys define the failure items. Value describes the exception or details of the item.",
"type": "object"
}
},
"type": "object"
},
"ExportMetadataRequest": {
"description": "Request message for DataprocMetastore.ExportMetadata.",
"id": "ExportMetadataRequest",
@@ -2070,6 +2212,47 @@
},
"type": "object"
},
"LatestBackup": {
"description": "The details of the latest scheduled backup.",
"id": "LatestBackup",
"properties": {
"backupId": {
"description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.",
"readOnly": true,
"type": "string"
},
"duration": {
"description": "Output only. The duration of the backup completion.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The time when the backup was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of the backup.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state of the backup is unknown.",
"The backup is in progress.",
"The backup completed.",
"The backup failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ListBackupsResponse": {
"description": "Response message for DataprocMetastore.ListBackups.",
"id": "ListBackupsResponse",
@@ -2207,7 +2390,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -2244,6 +2427,10 @@
"description": "Metadata about the service in a location.",
"id": "LocationMetadata",
"properties": {
"multiRegionMetadata": {
"$ref": "MultiRegionMetadata",
"description": "The multi-region metadata if the current region is a multi-region."
},
"supportedHiveMetastoreVersions": {
"description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.",
"items": {
@@ -2410,7 +2597,7 @@
"properties": {
"dataCatalogConfig": {
"$ref": "DataCatalogConfig",
"description": "The integration config for the Data Catalog service."
"description": "Optional. The integration config for the Data Catalog service."
},
"dataplexConfig": {
"$ref": "DataplexConfig",
@@ -2467,6 +2654,20 @@
"properties": {},
"type": "object"
},
"MultiRegionMetadata": {
"description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty.",
"id": "MultiRegionMetadata",
"properties": {
"constituentRegions": {
"description": "The regions constituting the multi-region.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NetworkConfig": {
"description": "Network configuration for the Dataproc Metastore service.",
"id": "NetworkConfig",
@@ -2477,6 +2678,10 @@
"$ref": "Consumer"
},
"type": "array"
},
"customRoutesEnabled": {
"description": "Enables custom routes to be imported and exported for the Dataproc Metastore service's peered VPC network.",
"type": "boolean"
}
},
"type": "object"
@@ -2510,7 +2715,7 @@
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
"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"
}
},
@@ -2644,6 +2849,10 @@
"readOnly": true,
"type": "string"
},
"backupLocation": {
"description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.",
"type": "string"
},
"details": {
"description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.",
"readOnly": true,
@@ -2703,7 +2912,11 @@
"id": "RestoreServiceRequest",
"properties": {
"backup": {
"description": "Required. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.",
"description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.",
"type": "string"
},
"backupLocation": {
"description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.",
"type": "string"
},
"requestId": {
@@ -2727,6 +2940,72 @@
},
"type": "object"
},
"ScalingConfig": {
"description": "Represents the scaling configuration of a metastore service.",
"id": "ScalingConfig",
"properties": {
"instanceSize": {
"description": "An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))",
"enum": [
"INSTANCE_SIZE_UNSPECIFIED",
"EXTRA_SMALL",
"SMALL",
"MEDIUM",
"LARGE",
"EXTRA_LARGE"
],
"enumDescriptions": [
"Unspecified instance size",
"Extra small instance size, maps to a scaling factor of 0.1.",
"Small instance size, maps to a scaling factor of 0.5.",
"Medium instance size, maps to a scaling factor of 1.0.",
"Large instance size, maps to a scaling factor of 3.0.",
"Extra large instance size, maps to a scaling factor of 6.0."
],
"type": "string"
},
"scalingFactor": {
"description": "Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"ScheduledBackup": {
"description": "This specifies the configuration of scheduled backup.",
"id": "ScheduledBackup",
"properties": {
"backupLocation": {
"description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.",
"type": "string"
},
"cronSchedule": {
"description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.",
"type": "string"
},
"enabled": {
"description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.",
"type": "boolean"
},
"latestBackup": {
"$ref": "LatestBackup",
"description": "Output only. The details of the latest scheduled backup.",
"readOnly": true
},
"nextScheduledTime": {
"description": "Output only. The time when the next backups execution is scheduled to start.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.",
"type": "string"
}
},
"type": "object"
},
"Secret": {
"description": "A securely stored value.",
"id": "Secret",
@@ -2793,7 +3072,7 @@
},
"metadataIntegration": {
"$ref": "MetadataIntegration",
"description": "The setting that defines how metastore metadata should be integrated with external services and systems."
"description": "Optional. The setting that defines how metastore metadata should be integrated with external services and systems."
},
"metadataManagementActivity": {
"$ref": "MetadataManagementActivity",
@@ -2831,6 +3110,14 @@
],
"type": "string"
},
"scalingConfig": {
"$ref": "ScalingConfig",
"description": "Scaling configuration of the metastore service."
},
"scheduledBackup": {
"$ref": "ScheduledBackup",
"description": "Optional. The configuration of scheduled backup for the metastore service."
},
"state": {
"description": "Output only. The current state of the metastore service.",
"enum": [

307
etc/api/metastore/v1beta/metastore-api.json
View File

@@ -448,6 +448,34 @@
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "metastore.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}",
@@ -499,7 +527,7 @@
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"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": "metastore.projects.locations.operations.list",
@@ -571,6 +599,34 @@
"https://www.googleapis.com/auth/cloud-platform"
]
},
"alterTableProperties": {
"description": "Alter metadata table properties.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:alterTableProperties",
"httpMethod": "POST",
"id": "metastore.projects.locations.services.alterTableProperties",
"parameterOrder": [
"service"
],
"parameters": {
"service": {
"description": "Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1beta/{+service}:alterTableProperties",
"request": {
"$ref": "AlterTablePropertiesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates a metastore service in a project and location.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services",
@@ -1543,6 +1599,40 @@
]
}
}
},
"migrationExecutions": {
"methods": {
"delete": {
"description": "Deletes a single migration execution.",
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/migrationExecutions/{migrationExecutionsId}",
"httpMethod": "DELETE",
"id": "metastore.projects.locations.services.migrationExecutions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The relative resource name of the migrationExecution to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/migrationExecutions/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request.For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments.The request ID must be a valid UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.",
"location": "query",
"type": "string"
}
},
"path": "v1beta/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
@@ -1551,7 +1641,7 @@
}
}
},
"revision": "20230111",
"revision": "20240228",
"rootUrl": "https://metastore.googleapis.com/",
"schemas": {
"AlterMetadataResourceLocationRequest": {
@@ -1575,6 +1665,29 @@
"properties": {},
"type": "object"
},
"AlterTablePropertiesRequest": {
"description": "Request message for DataprocMetastore.AlterTableProperties.",
"id": "AlterTablePropertiesRequest",
"properties": {
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask",
"type": "object"
},
"tableName": {
"description": "Required. The name of the table containing the properties you're altering in the following format.databases/{database_id}/tables/{table_id}",
"type": "string"
},
"updateMask": {
"description": "A field mask that specifies the metadata table properties that are overwritten by the update. Fields specified in the update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is:paths: \"properties.b\", \"properties.c\"then the result will be: properties { a: 1 b: 3 c: 4 } ",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "AuditConfig",
@@ -1654,11 +1767,13 @@
"description": "The type of the backend metastore.",
"enum": [
"METASTORE_TYPE_UNSPECIFIED",
"DATAPLEX",
"BIGQUERY",
"DATAPROC_METASTORE"
],
"enumDescriptions": [
"The metastore type is not set.",
"The backend metastore is Dataplex.",
"The backend metastore is BigQuery.",
"The backend metastore is Dataproc Metastore."
],
@@ -1741,23 +1856,34 @@
"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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
"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.",
"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",
"properties": {},
"type": "object"
},
"Consumer": {
"description": "Contains information of the customer's network configurations.",
"id": "Consumer",
"properties": {
"endpointLocation": {
"description": "Output only. The location of the endpoint URI. Format: projects/{project}/locations/{location}.",
"readOnly": true,
"type": "string"
},
"endpointUri": {
"description": "Output only. The URI of the endpoint used to access the metastore service.",
"readOnly": true,
@@ -1775,7 +1901,7 @@
"id": "DataCatalogConfig",
"properties": {
"enabled": {
"description": "Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.",
"description": "Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog.",
"type": "boolean"
}
},
@@ -1786,6 +1912,7 @@
"id": "DatabaseDump",
"properties": {
"databaseType": {
"deprecated": true,
"description": "The type of the database.",
"enum": [
"DATABASE_TYPE_UNSPECIFIED",
@@ -1802,6 +1929,7 @@
"type": "string"
},
"sourceDatabase": {
"deprecated": true,
"description": "The name of the source database.",
"type": "string"
},
@@ -1853,6 +1981,20 @@
},
"type": "object"
},
"ErrorDetails": {
"description": "Error details in public error message for DataprocMetastore.QueryMetadata.",
"id": "ErrorDetails",
"properties": {
"details": {
"additionalProperties": {
"type": "string"
},
"description": "Additional structured details about this error.Keys define the failure items. Value describes the exception or details of the item.",
"type": "object"
}
},
"type": "object"
},
"ExportMetadataRequest": {
"description": "Request message for DataprocMetastore.ExportMetadata.",
"id": "ExportMetadataRequest",
@@ -2070,6 +2212,47 @@
},
"type": "object"
},
"LatestBackup": {
"description": "The details of the latest scheduled backup.",
"id": "LatestBackup",
"properties": {
"backupId": {
"description": "Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress.",
"readOnly": true,
"type": "string"
},
"duration": {
"description": "Output only. The duration of the backup completion.",
"format": "google-duration",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Output only. The time when the backup was started.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of the backup.",
"enum": [
"STATE_UNSPECIFIED",
"IN_PROGRESS",
"SUCCEEDED",
"FAILED"
],
"enumDescriptions": [
"The state of the backup is unknown.",
"The backup is in progress.",
"The backup completed.",
"The backup failed."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ListBackupsResponse": {
"description": "Response message for DataprocMetastore.ListBackups.",
"id": "ListBackupsResponse",
@@ -2207,7 +2390,7 @@
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
@@ -2244,6 +2427,10 @@
"description": "Metadata about the service in a location.",
"id": "LocationMetadata",
"properties": {
"multiRegionMetadata": {
"$ref": "MultiRegionMetadata",
"description": "The multi-region metadata if the current region is a multi-region."
},
"supportedHiveMetastoreVersions": {
"description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.",
"items": {
@@ -2410,7 +2597,7 @@
"properties": {
"dataCatalogConfig": {
"$ref": "DataCatalogConfig",
"description": "The integration config for the Data Catalog service."
"description": "Optional. The integration config for the Data Catalog service."
},
"dataplexConfig": {
"$ref": "DataplexConfig",
@@ -2467,6 +2654,20 @@
"properties": {},
"type": "object"
},
"MultiRegionMetadata": {
"description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty.",
"id": "MultiRegionMetadata",
"properties": {
"constituentRegions": {
"description": "The regions constituting the multi-region.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NetworkConfig": {
"description": "Network configuration for the Dataproc Metastore service.",
"id": "NetworkConfig",
@@ -2477,6 +2678,10 @@
"$ref": "Consumer"
},
"type": "array"
},
"customRoutesEnabled": {
"description": "Enables custom routes to be imported and exported for the Dataproc Metastore service's peered VPC network.",
"type": "boolean"
}
},
"type": "object"
@@ -2510,7 +2715,7 @@
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
"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"
}
},
@@ -2644,6 +2849,10 @@
"readOnly": true,
"type": "string"
},
"backupLocation": {
"description": "Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format gs:///.",
"type": "string"
},
"details": {
"description": "Output only. The restore details containing the revision of the service to be restored to, in format of JSON.",
"readOnly": true,
@@ -2703,7 +2912,11 @@
"id": "RestoreServiceRequest",
"properties": {
"backup": {
"description": "Required. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.",
"description": "Optional. The relative resource name of the metastore service backup to restore from, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}. Mutually exclusive with backup_location, and exactly one of the two must be set.",
"type": "string"
},
"backupLocation": {
"description": "Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under \"avro/\", backup_metastore.json and service.json, in the following form:gs://. Mutually exclusive with backup, and exactly one of the two must be set.",
"type": "string"
},
"requestId": {
@@ -2727,6 +2940,72 @@
},
"type": "object"
},
"ScalingConfig": {
"description": "Represents the scaling configuration of a metastore service.",
"id": "ScalingConfig",
"properties": {
"instanceSize": {
"description": "An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1))",
"enum": [
"INSTANCE_SIZE_UNSPECIFIED",
"EXTRA_SMALL",
"SMALL",
"MEDIUM",
"LARGE",
"EXTRA_LARGE"
],
"enumDescriptions": [
"Unspecified instance size",
"Extra small instance size, maps to a scaling factor of 0.1.",
"Small instance size, maps to a scaling factor of 0.5.",
"Medium instance size, maps to a scaling factor of 1.0.",
"Large instance size, maps to a scaling factor of 3.0.",
"Extra large instance size, maps to a scaling factor of 6.0."
],
"type": "string"
},
"scalingFactor": {
"description": "Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"ScheduledBackup": {
"description": "This specifies the configuration of scheduled backup.",
"id": "ScheduledBackup",
"properties": {
"backupLocation": {
"description": "Optional. A Cloud Storage URI of a folder, in the format gs:///. A sub-folder containing backup files will be stored below it.",
"type": "string"
},
"cronSchedule": {
"description": "Optional. The scheduled interval in Cron format, see https://en.wikipedia.org/wiki/Cron The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups.",
"type": "string"
},
"enabled": {
"description": "Optional. Defines whether the scheduled backup is enabled. The default value is false.",
"type": "boolean"
},
"latestBackup": {
"$ref": "LatestBackup",
"description": "Output only. The details of the latest scheduled backup.",
"readOnly": true
},
"nextScheduledTime": {
"description": "Output only. The time when the next backups execution is scheduled to start.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones), e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC.",
"type": "string"
}
},
"type": "object"
},
"Secret": {
"description": "A securely stored value.",
"id": "Secret",
@@ -2793,7 +3072,7 @@
},
"metadataIntegration": {
"$ref": "MetadataIntegration",
"description": "The setting that defines how metastore metadata should be integrated with external services and systems."
"description": "Optional. The setting that defines how metastore metadata should be integrated with external services and systems."
},
"metadataManagementActivity": {
"$ref": "MetadataManagementActivity",
@@ -2831,6 +3110,14 @@
],
"type": "string"
},
"scalingConfig": {
"$ref": "ScalingConfig",
"description": "Scaling configuration of the metastore service."
},
"scheduledBackup": {
"$ref": "ScheduledBackup",
"description": "Optional. The configuration of scheduled backup for the metastore service."
},
"state": {
"description": "Output only. The current state of the metastore service.",
"enum": [