1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DataprocMetastore
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsServices

ProjectsLocationsServices

class ProjectsLocationsServices extends Resource (View source)

The "services" collection of methods.

Typical usage is:

 $metastoreService = new Google\Service\DataprocMetastore(...);
 $services = $metastoreService->projects_locations_services;

Methods

Operation
alterLocation(string $service, AlterMetadataResourceLocationRequest $postBody, array $optParams = [])

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. (services.alterLocation)

Operation
alterTableProperties(string $service, AlterTablePropertiesRequest $postBody, array $optParams = [])

Alter metadata table properties. (services.alterTableProperties)

Operation
cancelMigration(string $service, CancelMigrationRequest $postBody, array $optParams = [])

Cancels the ongoing Managed Migration process. (services.cancelMigration)

Operation
completeMigration(string $service, CompleteMigrationRequest $postBody, array $optParams = [])

Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.

Operation
create(string $parent, Service $postBody, array $optParams = [])

Creates a metastore service in a project and location. (services.create)

Operation
delete(string $name, array $optParams = [])

Deletes a single service. (services.delete)

Operation
exportMetadata(string $service, ExportMetadataRequest $postBody, array $optParams = [])

Exports metadata from a service. (services.exportMetadata)

Service
get(string $name, array $optParams = [])

Gets the details of a single service. (services.get)

Policy
getIamPolicy(string $resource, array $optParams = [])

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

ListServicesResponse
listProjectsLocationsServices(string $parent, array $optParams = [])

Lists services in a project and location.

Operation
moveTableToDatabase(string $service, MoveTableToDatabaseRequest $postBody, array $optParams = [])

Move a table to another database. (services.moveTableToDatabase)

Operation
patch(string $name, Service $postBody, array $optParams = [])

Updates the parameters of a single service. (services.patch)

Operation
queryMetadata(string $service, QueryMetadataRequest $postBody, array $optParams = [])

Query Dataproc Metastore metadata. (services.queryMetadata)

Operation
restore(string $service, RestoreServiceRequest $postBody, array $optParams = [])

Restores a service from a backup. (services.restore)

Policy
setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

Operation
startMigration(string $service, StartMigrationRequest $postBody, array $optParams = [])

Starts the Managed Migration process. (services.startMigration)

TestIamPermissionsResponse
testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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.

Details

at line 61
Operation alterLocation(string $service, AlterMetadataResourceLocationRequest $postBody, array $optParams = [])

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. (services.alterLocation)

Parameters

string $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}.
AlterMetadataResourceLocationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 79
Operation alterTableProperties(string $service, AlterTablePropertiesRequest $postBody, array $optParams = [])

Alter metadata table properties. (services.alterTableProperties)

Parameters

string $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}.
AlterTablePropertiesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 96
Operation cancelMigration(string $service, CancelMigrationRequest $postBody, array $optParams = [])

Cancels the ongoing Managed Migration process. (services.cancelMigration)

Parameters

string $service

Required. The relative resource name of the metastore service to cancel the ongoing migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
CancelMigrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 115
Operation completeMigration(string $service, CompleteMigrationRequest $postBody, array $optParams = [])

Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration.

(services.completeMigration)

Parameters

string $service

Required. The relative resource name of the metastore service to complete the migration to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
CompleteMigrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 147
Operation create(string $parent, Service $postBody, array $optParams = [])

Creates a metastore service in a project and location. (services.create)

Parameters

string $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}.
Service $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 173
Operation delete(string $name, array $optParams = [])

Deletes a single service. (services.delete)

Parameters

string $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}.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 190
Operation exportMetadata(string $service, ExportMetadataRequest $postBody, array $optParams = [])

Exports metadata from a service. (services.exportMetadata)

Parameters

string $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}.
ExportMetadataRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 206
Service get(string $name, array $optParams = [])

Gets the details of a single service. (services.get)

Parameters

string $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}.
array $optParams

Optional parameters.

Return Value

Service

Exceptions

Exception

at line 236
Policy getIamPolicy(string $resource, array $optParams = [])

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

Parameters

string $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.
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 268
ListServicesResponse listProjectsLocationsServices(string $parent, array $optParams = [])

Lists services in a project and location.

(services.listProjectsLocationsServices)

Parameters

string $parent

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

Optional parameters.

Return Value

ListServicesResponse

Exceptions

Exception

at line 285
Operation moveTableToDatabase(string $service, MoveTableToDatabaseRequest $postBody, array $optParams = [])

Move a table to another database. (services.moveTableToDatabase)

Parameters

string $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}.
MoveTableToDatabaseRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 316
Operation patch(string $name, Service $postBody, array $optParams = [])

Updates the parameters of a single service. (services.patch)

Parameters

string $name

Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{locatio n_id}/services/{service_id}.
Service $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 333
Operation queryMetadata(string $service, QueryMetadataRequest $postBody, array $optParams = [])

Query Dataproc Metastore metadata. (services.queryMetadata)

Parameters

string $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}.
QueryMetadataRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 350
Operation restore(string $service, RestoreServiceRequest $postBody, array $optParams = [])

Restores a service from a backup. (services.restore)

Parameters

string $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}.
RestoreServiceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 370
Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

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

Parameters

string $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.
SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

at line 387
Operation startMigration(string $service, StartMigrationRequest $postBody, array $optParams = [])

Starts the Managed Migration process. (services.startMigration)

Parameters

string $service

Required. The relative resource name of the metastore service to start migrating to, in the following format:projects/{project_id}/locations/{location_id}/services/{service_id}.
StartMigrationRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 409
TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

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. (services.testIamPermissions)

Parameters

string $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.
TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception