Google Cloud Dataplex V1 Client - Class MetadataJob (1.7.1)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class MetadataJob.

A metadata job resource.

Generated from protobuf message google.cloud.dataplex.v1.MetadataJob

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. Identifier. The name of the resource that the configuration is applied to, in the format `projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}`.
`↳ uid`	`string` Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. The time when the metadata job was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. The time when the metadata job was updated.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. User-defined labels.
`↳ type`	`int` Required. Metadata job type.
`↳ import_spec`	`MetadataJob\ImportJobSpec` Import job specification.
`↳ export_spec`	`MetadataJob\ExportJobSpec` Export job specification.
`↳ import_result`	`MetadataJob\ImportJobResult` Output only. Import job result.
`↳ export_result`	`MetadataJob\ExportJobResult` Output only. Export job result.
`↳ status`	`MetadataJob\Status` Output only. Metadata job status.

getName

Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.

Returns
Type	Description
`string`

setName

Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUid

Output only. A system-generated, globally unique ID for the metadata job.

If the metadata job is deleted and then re-created with the same name, this ID is different.

Returns
Type	Description
`string`

setUid

Output only. A system-generated, globally unique ID for the metadata job.

If the metadata job is deleted and then re-created with the same name, this ID is different.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. The time when the metadata job was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time when the metadata job was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. The time when the metadata job was updated.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time when the metadata job was updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getLabels

Optional. User-defined labels.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Optional. User-defined labels.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getType

Required. Metadata job type.

Returns
Type	Description
`int`	Enum of type Type.

setType

Required. Metadata job type.

Parameter
Name	Description
`var`	`int` Enum of type Type.

Returns
Type	Description
`$this`

getImportSpec

Import job specification.

Returns
Type	Description
`MetadataJob\ImportJobSpec\|null`

hasImportSpec

setImportSpec

Import job specification.

Parameter
Name	Description
`var`	`MetadataJob\ImportJobSpec`

Returns
Type	Description
`$this`

getExportSpec

Export job specification.

Returns
Type	Description
`MetadataJob\ExportJobSpec\|null`

hasExportSpec

setExportSpec