Google Cloud Dataplex V1 Client - Class MetadataJob (1.1.0)

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.

↳ import_result MetadataJob\ImportJobResult

Output only. Import 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

setType

Required. Metadata job type.

Parameter
Name Description
var int
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

getImportResult

Output only. Import job result.

Returns
Type Description
MetadataJob\ImportJobResult|null

hasImportResult

setImportResult

Output only. Import job result.

Parameter
Name Description
var MetadataJob\ImportJobResult
Returns
Type Description
$this

getStatus

Output only. Metadata job status.

Returns
Type Description
MetadataJob\Status|null

hasStatus

clearStatus

setStatus

Output only. Metadata job status.

Parameter
Name Description
var MetadataJob\Status
Returns
Type Description
$this

getSpec

Returns
Type Description
string

getResult

Returns
Type Description
string