Class MetadataJob.ExportJobSpec.Builder (1.81.0)

public static final class MetadataJob.ExportJobSpec.Builder extends GeneratedMessage.Builder<MetadataJob.ExportJobSpec.Builder> implements MetadataJob.ExportJobSpecOrBuilder

Job specification for a metadata export job.

Protobuf type google.cloud.dataplex.v1.MetadataJob.ExportJobSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public MetadataJob.ExportJobSpec build()
Returns
Type Description
MetadataJob.ExportJobSpec

buildPartial()

public MetadataJob.ExportJobSpec buildPartial()
Returns
Type Description
MetadataJob.ExportJobSpec

clear()

public MetadataJob.ExportJobSpec.Builder clear()
Returns
Type Description
MetadataJob.ExportJobSpec.Builder
Overrides

clearOutputPath()

public MetadataJob.ExportJobSpec.Builder clearOutputPath()

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 Universal Catalog 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.

string output_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ExportJobSpec.Builder

This builder for chaining.

clearScope()

public MetadataJob.ExportJobSpec.Builder clearScope()

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ExportJobSpec.Builder

getDefaultInstanceForType()

public MetadataJob.ExportJobSpec getDefaultInstanceForType()
Returns
Type Description
MetadataJob.ExportJobSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getOutputPath()

public String 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 Universal Catalog 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.

string output_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The outputPath.

getOutputPathBytes()

public ByteString getOutputPathBytes()

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 Universal Catalog 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.

string output_path = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for outputPath.

getScope()

public MetadataJob.ExportJobSpec.ExportJobScope getScope()

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope

The scope.

getScopeBuilder()

public MetadataJob.ExportJobSpec.ExportJobScope.Builder getScopeBuilder()

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScope.Builder

getScopeOrBuilder()

public MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder getScopeOrBuilder()

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MetadataJob.ExportJobSpec.ExportJobScopeOrBuilder

hasScope()

public boolean hasScope()

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the scope field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(MetadataJob.ExportJobSpec other)

public MetadataJob.ExportJobSpec.Builder mergeFrom(MetadataJob.ExportJobSpec other)
Parameter
Name Description
other MetadataJob.ExportJobSpec
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public MetadataJob.ExportJobSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public MetadataJob.ExportJobSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
MetadataJob.ExportJobSpec.Builder
Overrides

mergeScope(MetadataJob.ExportJobSpec.ExportJobScope value)

public MetadataJob.ExportJobSpec.Builder mergeScope(MetadataJob.ExportJobSpec.ExportJobScope value)

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value MetadataJob.ExportJobSpec.ExportJobScope
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

setOutputPath(String value)

public MetadataJob.ExportJobSpec.Builder setOutputPath(String value)

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 Universal Catalog 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.

string output_path = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The outputPath to set.

Returns
Type Description
MetadataJob.ExportJobSpec.Builder

This builder for chaining.

setOutputPathBytes(ByteString value)

public MetadataJob.ExportJobSpec.Builder setOutputPathBytes(ByteString value)

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 Universal Catalog 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.

string output_path = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for outputPath to set.

Returns
Type Description
MetadataJob.ExportJobSpec.Builder

This builder for chaining.

setScope(MetadataJob.ExportJobSpec.ExportJobScope value)

public MetadataJob.ExportJobSpec.Builder setScope(MetadataJob.ExportJobSpec.ExportJobScope value)

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value MetadataJob.ExportJobSpec.ExportJobScope
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

setScope(MetadataJob.ExportJobSpec.ExportJobScope.Builder builderForValue)

public MetadataJob.ExportJobSpec.Builder setScope(MetadataJob.ExportJobSpec.ExportJobScope.Builder builderForValue)

Required. The scope of the export job.

.google.cloud.dataplex.v1.MetadataJob.ExportJobSpec.ExportJobScope scope = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue MetadataJob.ExportJobSpec.ExportJobScope.Builder
Returns
Type Description
MetadataJob.ExportJobSpec.Builder