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

ProjectsLocationsMetadataJobs

class ProjectsLocationsMetadataJobs extends Resource (View source)

The "metadataJobs" collection of methods.

Typical usage is:

 $dataplexService = new Google\Service\CloudDataplex(...);
 $metadataJobs = $dataplexService->projects_locations_metadataJobs;

Methods

DataplexEmpty
cancel(string $name, GoogleCloudDataplexV1CancelMetadataJobRequest $postBody, array $optParams = [])

Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

GoogleLongrunningOperation
create(string $parent, GoogleCloudDataplexV1MetadataJob $postBody, array $optParams = [])

Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

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

Gets a metadata job. (metadataJobs.get)

GoogleCloudDataplexV1ListMetadataJobsResponse
listProjectsLocationsMetadataJobs(string $parent, array $optParams = [])

Lists metadata jobs. (metadataJobs.listProjectsLocationsMetadataJobs)

Details

at line 51
DataplexEmpty cancel(string $name, GoogleCloudDataplexV1CancelMetadataJobRequest $postBody, array $optParams = [])

Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

(metadataJobs.cancel)

Parameters

string $name

Required. The resource name of the job, in the format pro jects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_j ob_id}
GoogleCloudDataplexV1CancelMetadataJobRequest $postBody
array $optParams

Optional parameters.

Return Value

DataplexEmpty

Exceptions

Exception

at line 72
GoogleLongrunningOperation create(string $parent, GoogleCloudDataplexV1MetadataJob $postBody, array $optParams = [])

Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

(metadataJobs.create)

Parameters

string $parent

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}
GoogleCloudDataplexV1MetadataJob $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 88
GoogleCloudDataplexV1MetadataJob get(string $name, array $optParams = [])

Gets a metadata job. (metadataJobs.get)

Parameters

string $name

Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{ metadata_job_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1MetadataJob

Exceptions

Exception

at line 117
GoogleCloudDataplexV1ListMetadataJobsResponse listProjectsLocationsMetadataJobs(string $parent, array $optParams = [])

Lists metadata jobs. (metadataJobs.listProjectsLocationsMetadataJobs)

Parameters

string $parent

Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDataplexV1ListMetadataJobsResponse

Exceptions

Exception