Class MetadataJob.ExportJobSpec (1.73.0) 

public static final class MetadataJob.ExportJobSpec extends GeneratedMessageV3 implements MetadataJob.ExportJobSpecOrBuilder

Job specification for a metadata export job.

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetadataJob.ExportJobSpec

Static Fields

OUTPUT_PATH_FIELD_NUMBER

public static final int OUTPUT_PATH_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_FIELD_NUMBER

public static final int SCOPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MetadataJob.ExportJobSpec getDefaultInstance()
Returns
Type Description
MetadataJob.ExportJobSpec

getDescriptor()

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

newBuilder()

public static MetadataJob.ExportJobSpec.Builder newBuilder()
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

newBuilder(MetadataJob.ExportJobSpec prototype)

public static MetadataJob.ExportJobSpec.Builder newBuilder(MetadataJob.ExportJobSpec prototype)
Parameter
Name Description
prototype MetadataJob.ExportJobSpec
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

parseDelimitedFrom(InputStream input)

public static MetadataJob.ExportJobSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static MetadataJob.ExportJobSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MetadataJob.ExportJobSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MetadataJob.ExportJobSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static MetadataJob.ExportJobSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static MetadataJob.ExportJobSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MetadataJob.ExportJobSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
MetadataJob.ExportJobSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<MetadataJob.ExportJobSpec> parser()
Returns
Type Description
Parser<ExportJobSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

getParserForType()

public Parser<MetadataJob.ExportJobSpec> getParserForType()
Returns
Type Description
Parser<ExportJobSpec>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public MetadataJob.ExportJobSpec.Builder newBuilderForType()
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MetadataJob.ExportJobSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MetadataJob.ExportJobSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public MetadataJob.ExportJobSpec.Builder toBuilder()
Returns
Type Description
MetadataJob.ExportJobSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException