Metastore

import { Metastore } from "https://googleapis.deno.dev/v1/metastore:v1.ts";

The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.

class Metastore {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsLocationsFederationsCreate(

parent: string,

req: Federation,

opts?: ProjectsLocationsFederationsCreateOptions,

): Promise<Operation>;

async projectsLocationsFederationsDelete(name: string, opts?: ProjectsLocationsFederationsDeleteOptions): Promise<Operation>;

async projectsLocationsFederationsGet(name: string): Promise<Federation>;

async projectsLocationsFederationsGetIamPolicy(resource: string, opts?: ProjectsLocationsFederationsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsFederationsList(parent: string, opts?: ProjectsLocationsFederationsListOptions): Promise<ListFederationsResponse>;

async projectsLocationsFederationsPatch(

req: Federation,

opts?: ProjectsLocationsFederationsPatchOptions,

): Promise<Operation>;

async projectsLocationsFederationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsFederationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsServicesAlterLocation(service: string, req: AlterMetadataResourceLocationRequest): Promise<Operation>;

async projectsLocationsServicesAlterTableProperties(service: string, req: AlterTablePropertiesRequest): Promise<Operation>;

async projectsLocationsServicesBackupsCreate(

parent: string,

req: Backup,

opts?: ProjectsLocationsServicesBackupsCreateOptions,

): Promise<Operation>;

async projectsLocationsServicesBackupsDelete(name: string, opts?: ProjectsLocationsServicesBackupsDeleteOptions): Promise<Operation>;

async projectsLocationsServicesBackupsGet(name: string): Promise<Backup>;

async projectsLocationsServicesBackupsGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesBackupsGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsServicesBackupsList(parent: string, opts?: ProjectsLocationsServicesBackupsListOptions): Promise<ListBackupsResponse>;

async projectsLocationsServicesBackupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsServicesCreate(

parent: string,

req: Service,

opts?: ProjectsLocationsServicesCreateOptions,

): Promise<Operation>;

async projectsLocationsServicesDelete(name: string, opts?: ProjectsLocationsServicesDeleteOptions): Promise<Operation>;

async projectsLocationsServicesExportMetadata(service: string, req: ExportMetadataRequest): Promise<Operation>;

async projectsLocationsServicesGet(name: string): Promise<Service>;

async projectsLocationsServicesGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesGetIamPolicyOptions): Promise<Policy>;

async projectsLocationsServicesList(parent: string, opts?: ProjectsLocationsServicesListOptions): Promise<ListServicesResponse>;

async projectsLocationsServicesMetadataImportsCreate(

parent: string,

req: MetadataImport,

opts?: ProjectsLocationsServicesMetadataImportsCreateOptions,

): Promise<Operation>;

async projectsLocationsServicesMetadataImportsGet(name: string): Promise<MetadataImport>;

async projectsLocationsServicesMetadataImportsList(parent: string, opts?: ProjectsLocationsServicesMetadataImportsListOptions): Promise<ListMetadataImportsResponse>;

async projectsLocationsServicesMetadataImportsPatch(

req: MetadataImport,

opts?: ProjectsLocationsServicesMetadataImportsPatchOptions,

): Promise<Operation>;

async projectsLocationsServicesMoveTableToDatabase(service: string, req: MoveTableToDatabaseRequest): Promise<Operation>;

async projectsLocationsServicesPatch(

req: Service,

opts?: ProjectsLocationsServicesPatchOptions,

): Promise<Operation>;

async projectsLocationsServicesQueryMetadata(service: string, req: QueryMetadataRequest): Promise<Operation>;

async projectsLocationsServicesRestore(service: string, req: RestoreServiceRequest): Promise<Operation>;

async projectsLocationsServicesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>;

async projectsLocationsServicesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>;

}

§Constructors

new Metastore(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsLocationsFederationsCreate(parent: string, req: Federation, opts?: ProjectsLocationsFederationsCreateOptions): Promise<Operation>

[src]

Creates a metastore federation in a project and location.

@param parent

Required. The relative resource name of the location in which to create a federation service, in the following form:projects/{project_number}/locations/{location_id}.

projectsLocationsFederationsDelete(name: string, opts?: ProjectsLocationsFederationsDeleteOptions): Promise<Operation>

[src]

Deletes a single federation.

@param name

Required. The relative resource name of the metastore federation to delete, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

projectsLocationsFederationsGet(name: string): Promise<Federation>

[src]

Gets the details of a single federation.

@param name

Required. The relative resource name of the metastore federation to retrieve, in the following form:projects/{project_number}/locations/{location_id}/federations/{federation_id}.

projectsLocationsFederationsGetIamPolicy(resource: string, opts?: ProjectsLocationsFederationsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

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.

projectsLocationsFederationsList(parent: string, opts?: ProjectsLocationsFederationsListOptions): Promise<ListFederationsResponse>

[src]

Lists federations in a project and location.

@param parent

Required. The relative resource name of the location of metastore federations to list, in the following form: projects/{project_number}/locations/{location_id}.

projectsLocationsFederationsPatch(name: string, req: Federation, opts?: ProjectsLocationsFederationsPatchOptions): Promise<Operation>

[src]

Updates the fields of a federation.

@param name

Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

projectsLocationsFederationsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

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.

projectsLocationsFederationsTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

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 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.

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

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 name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

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 name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

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 name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsServicesAlterLocation(service: string, req: AlterMetadataResourceLocationRequest): Promise<Operation>

[src]

Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.

@param service

Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesAlterTableProperties(service: string, req: AlterTablePropertiesRequest): Promise<Operation>

[src]

Alter metadata table properties.

@param service

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}.

projectsLocationsServicesBackupsCreate(parent: string, req: Backup, opts?: ProjectsLocationsServicesBackupsCreateOptions): Promise<Operation>

[src]

Creates a new backup in a given project and location.

@param parent

Required. The relative resource name of the service in which to create a backup of the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesBackupsDelete(name: string, opts?: ProjectsLocationsServicesBackupsDeleteOptions): Promise<Operation>

[src]

Deletes a single backup.

@param name

Required. The relative resource name of the backup to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

projectsLocationsServicesBackupsGet(name: string): Promise<Backup>

[src]

Gets details of a single backup.

@param name

Required. The relative resource name of the backup to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

projectsLocationsServicesBackupsGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesBackupsGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

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.

projectsLocationsServicesBackupsList(parent: string, opts?: ProjectsLocationsServicesBackupsListOptions): Promise<ListBackupsResponse>

[src]

Lists backups in a service.

@param parent

Required. The relative resource name of the service whose backups to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups.

projectsLocationsServicesBackupsSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

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.

projectsLocationsServicesCreate(parent: string, req: Service, opts?: ProjectsLocationsServicesCreateOptions): Promise<Operation>

[src]

Creates a metastore service in a project and location.

@param parent

Required. The relative resource name of the location in which to create a metastore service, in the following form:projects/{project_number}/locations/{location_id}.

projectsLocationsServicesDelete(name: string, opts?: ProjectsLocationsServicesDeleteOptions): Promise<Operation>

[src]

Deletes a single service.

@param name

Required. The relative resource name of the metastore service to delete, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesExportMetadata(service: string, req: ExportMetadataRequest): Promise<Operation>

[src]

Exports metadata from a service.

@param service

Required. The relative resource name of the metastore service to run export, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesGet(name: string): Promise<Service>

[src]

Gets the details of a single service.

@param name

Required. The relative resource name of the metastore service to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesGetIamPolicy(resource: string, opts?: ProjectsLocationsServicesGetIamPolicyOptions): Promise<Policy>

[src]

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

@param resource

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.

projectsLocationsServicesList(parent: string, opts?: ProjectsLocationsServicesListOptions): Promise<ListServicesResponse>

[src]

Lists services in a project and location.

@param parent

Required. The relative resource name of the location of metastore services to list, in the following form:projects/{project_number}/locations/{location_id}.

projectsLocationsServicesMetadataImportsCreate(parent: string, req: MetadataImport, opts?: ProjectsLocationsServicesMetadataImportsCreateOptions): Promise<Operation>

[src]

Creates a new MetadataImport in a given project and location.

@param parent

Required. The relative resource name of the service in which to create a metastore import, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesMetadataImportsGet(name: string): Promise<MetadataImport>

[src]

Gets details of a single import.

@param name

Required. The relative resource name of the metadata import to retrieve, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}.

projectsLocationsServicesMetadataImportsList(parent: string, opts?: ProjectsLocationsServicesMetadataImportsListOptions): Promise<ListMetadataImportsResponse>

[src]

Lists imports in a service.

@param parent

Required. The relative resource name of the service whose metadata imports to list, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports.

projectsLocationsServicesMetadataImportsPatch(name: string, req: MetadataImport, opts?: ProjectsLocationsServicesMetadataImportsPatchOptions): Promise<Operation>

[src]

Updates a single import. Only the description field of MetadataImport is supported to be updated.

@param name

Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}.

projectsLocationsServicesMoveTableToDatabase(service: string, req: MoveTableToDatabaseRequest): Promise<Operation>

[src]

Move a table to another database.

@param service

Required. The relative resource name of the metastore service to mutate metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesPatch(name: string, req: Service, opts?: ProjectsLocationsServicesPatchOptions): Promise<Operation>

[src]

Updates the parameters of a single service.

@param name

Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesQueryMetadata(service: string, req: QueryMetadataRequest): Promise<Operation>

[src]

Query Dataproc Metastore metadata.

@param service

Required. The relative resource name of the metastore service to query metadata, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesRestore(service: string, req: RestoreServiceRequest): Promise<Operation>

[src]

Restores a service from a backup.

@param service

Required. The relative resource name of the metastore service to run restore, in the following form:projects/{project_id}/locations/{location_id}/services/{service_id}.

projectsLocationsServicesSetIamPolicy(resource: string, req: SetIamPolicyRequest): Promise<Policy>

[src]

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

@param resource

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.

projectsLocationsServicesTestIamPermissions(resource: string, req: TestIamPermissionsRequest): Promise<TestIamPermissionsResponse>

[src]

@param 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.