Class ExportDataConfig (3.44.0)

public final class ExportDataConfig extends GeneratedMessageV3 implements ExportDataConfigOrBuilder

Describes what part of the Dataset is to be exported, the destination of the export and how to export.

Protobuf type google.cloud.aiplatform.v1beta1.ExportDataConfig

Static Fields

ANNOTATIONS_FILTER_FIELD_NUMBER

public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
Field Value
Type Description
int

FRACTION_SPLIT_FIELD_NUMBER

public static final int FRACTION_SPLIT_FIELD_NUMBER
Field Value
Type Description
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportDataConfig getDefaultInstance()
Returns
Type Description
ExportDataConfig

getDescriptor()

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

newBuilder()

public static ExportDataConfig.Builder newBuilder()
Returns
Type Description
ExportDataConfig.Builder

newBuilder(ExportDataConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static ExportDataConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDataConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ExportDataConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportDataConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ExportDataConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportDataConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ExportDataConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDataConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ExportDataConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportDataConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ExportDataConfig> parser()
Returns
Type Description
Parser<ExportDataConfig>

Methods

equals(Object obj)

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

getAnnotationsFilter()

public String getAnnotationsFilter()

An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.

string annotations_filter = 2;

Returns
Type Description
String

The annotationsFilter.

getAnnotationsFilterBytes()

public ByteString getAnnotationsFilterBytes()

An expression for filtering what part of the Dataset is to be exported. Only Annotations that match this filter will be exported. The filter syntax is the same as in ListAnnotations.

string annotations_filter = 2;

Returns
Type Description
ByteString

The bytes for annotationsFilter.

getDefaultInstanceForType()

public ExportDataConfig getDefaultInstanceForType()
Returns
Type Description
ExportDataConfig

getDestinationCase()

public ExportDataConfig.DestinationCase getDestinationCase()
Returns
Type Description
ExportDataConfig.DestinationCase

getFractionSplit()

public ExportFractionSplit getFractionSplit()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.ExportFractionSplit fraction_split = 5;

Returns
Type Description
ExportFractionSplit

The fractionSplit.

getFractionSplitOrBuilder()

public ExportFractionSplitOrBuilder getFractionSplitOrBuilder()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.ExportFractionSplit fraction_split = 5;

Returns
Type Description
ExportFractionSplitOrBuilder

getGcsDestination()

public GcsDestination getGcsDestination()

The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestination

The gcsDestination.

getGcsDestinationOrBuilder()

public GcsDestinationOrBuilder getGcsDestinationOrBuilder()

The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
GcsDestinationOrBuilder

getParserForType()

public Parser<ExportDataConfig> getParserForType()
Returns
Type Description
Parser<ExportDataConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSplitCase()

public ExportDataConfig.SplitCase getSplitCase()
Returns
Type Description
ExportDataConfig.SplitCase

hasFractionSplit()

public boolean hasFractionSplit()

Split based on fractions defining the size of each set.

.google.cloud.aiplatform.v1beta1.ExportFractionSplit fraction_split = 5;

Returns
Type Description
boolean

Whether the fractionSplit field is set.

hasGcsDestination()

public boolean hasGcsDestination()

The Google Cloud Storage location where the output is to be written to. In the given directory a new directory will be created with name: export-data-<dataset-display-name>-<timestamp-of-export-call> where timestamp is in YYYY-MM-DDThh:mm:ss.sssZ ISO-8601 format. All export output will be written into that directory. Inside that directory, annotations with the same schema will be grouped into sub directories which are named with the corresponding annotations' schema title. Inside these sub directories, a schema.yaml will be created to describe the output format.

.google.cloud.aiplatform.v1beta1.GcsDestination gcs_destination = 1;

Returns
Type Description
boolean

Whether the gcsDestination 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 ExportDataConfig.Builder newBuilderForType()
Returns
Type Description
ExportDataConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ExportDataConfig.Builder toBuilder()
Returns
Type Description
ExportDataConfig.Builder

writeTo(CodedOutputStream output)

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