Google Cloud Dataplex V1 Client - Class ExportJobSpec (1.6.1)

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

Job specification for a metadata export job.

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

Namespace

Google \ Cloud \ Dataplex \ V1 \ MetadataJob

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ scope ExportJobSpec\ExportJobScope

Required. The scope of the export job.
↳ output_path string

Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path. The bucket must be in the same VPC Service Controls perimeter as the job.

getScope

Required. The scope of the export job.

Returns
Type Description
ExportJobSpec\ExportJobScope|null

hasScope

clearScope

setScope

Required. The scope of the export job.

Parameter
Name Description
var ExportJobSpec\ExportJobScope
Returns
Type Description
$this

getOutputPath

Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.

The bucket must be in the same VPC Service Controls perimeter as the job.

Returns
Type Description
string

setOutputPath

Required. The root path of the Cloud Storage bucket to export the metadata to, in the format gs://{bucket}/. You can optionally specify a custom prefix after the bucket name, in the format gs://{bucket}/{prefix}/. The maximum length of the custom prefix is 128 characters. Dataplex constructs the object path for the exported files by using the bucket name and prefix that you provide, followed by a system-generated path.

The bucket must be in the same VPC Service Controls perimeter as the job.

Parameter
Name Description
var string
Returns
Type Description
$this