Class ExportDataConfig (3.35.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.v1.ExportDataConfig

Static Fields

ANNOTATIONS_FILTER_FIELD_NUMBER

public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

ANNOTATION_SCHEMA_URI_FIELD_NUMBER

public static final int ANNOTATION_SCHEMA_URI_FIELD_NUMBER
Field Value
TypeDescription
int

EXPORT_USE_FIELD_NUMBER

public static final int EXPORT_USE_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_SPLIT_FIELD_NUMBER

public static final int FILTER_SPLIT_FIELD_NUMBER
Field Value
TypeDescription
int

FRACTION_SPLIT_FIELD_NUMBER

public static final int FRACTION_SPLIT_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_DESTINATION_FIELD_NUMBER

public static final int GCS_DESTINATION_FIELD_NUMBER
Field Value
TypeDescription
int

SAVED_QUERY_ID_FIELD_NUMBER

public static final int SAVED_QUERY_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExportDataConfig getDefaultInstance()
Returns
TypeDescription
ExportDataConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ExportDataConfig.Builder newBuilder()
Returns
TypeDescription
ExportDataConfig.Builder

newBuilder(ExportDataConfig prototype)

public static ExportDataConfig.Builder newBuilder(ExportDataConfig prototype)
Parameter
NameDescription
prototypeExportDataConfig
Returns
TypeDescription
ExportDataConfig.Builder

parseDelimitedFrom(InputStream input)

public static ExportDataConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExportDataConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportDataConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportDataConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExportDataConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExportDataConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportDataConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportDataConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExportDataConfig> parser()
Returns
TypeDescription
Parser<ExportDataConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAnnotationSchemaUri()

public String getAnnotationSchemaUri()

The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by [dataset_id][].

Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

string annotation_schema_uri = 12;

Returns
TypeDescription
String

The annotationSchemaUri.

getAnnotationSchemaUriBytes()

public ByteString getAnnotationSchemaUriBytes()

The Cloud Storage URI that points to a YAML file describing the annotation schema. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/annotation/, note that the chosen schema must be consistent with metadata of the Dataset specified by [dataset_id][].

Only used for custom training data export use cases. Only applicable to Datasets that have DataItems and Annotations.

Only Annotations that both match this schema and belong to DataItems not ignored by the split method are used in respectively training, validation or test role, depending on the role of the DataItem they are on.

When used in conjunction with annotations_filter, the Annotations used for training are filtered by both annotations_filter and annotation_schema_uri.

string annotation_schema_uri = 12;

Returns
TypeDescription
ByteString

The bytes for annotationSchemaUri.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for annotationsFilter.

getDefaultInstanceForType()

public ExportDataConfig getDefaultInstanceForType()
Returns
TypeDescription
ExportDataConfig

getDestinationCase()

public ExportDataConfig.DestinationCase getDestinationCase()
Returns
TypeDescription
ExportDataConfig.DestinationCase

getExportUse()

public ExportDataConfig.ExportUse getExportUse()

Indicates the usage of the exported files.

.google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;

Returns
TypeDescription
ExportDataConfig.ExportUse

The exportUse.

getExportUseValue()

public int getExportUseValue()

Indicates the usage of the exported files.

.google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for exportUse.

getFilterSplit()

public ExportFilterSplit getFilterSplit()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;

Returns
TypeDescription
ExportFilterSplit

The filterSplit.

getFilterSplitOrBuilder()

public ExportFilterSplitOrBuilder getFilterSplitOrBuilder()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;

Returns
TypeDescription
ExportFilterSplitOrBuilder

getFractionSplit()

public ExportFractionSplit getFractionSplit()

Split based on fractions defining the size of each set.

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

Returns
TypeDescription
ExportFractionSplit

The fractionSplit.

getFractionSplitOrBuilder()

public ExportFractionSplitOrBuilder getFractionSplitOrBuilder()

Split based on fractions defining the size of each set.

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

Returns
TypeDescription
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.v1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
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.v1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
GcsDestinationOrBuilder

getParserForType()

public Parser<ExportDataConfig> getParserForType()
Returns
TypeDescription
Parser<ExportDataConfig>
Overrides

getSavedQueryId()

public String getSavedQueryId()

The ID of a SavedQuery (annotation set) under the Dataset specified by [dataset_id][] used for filtering Annotations for training.

Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

string saved_query_id = 11;

Returns
TypeDescription
String

The savedQueryId.

getSavedQueryIdBytes()

public ByteString getSavedQueryIdBytes()

The ID of a SavedQuery (annotation set) under the Dataset specified by [dataset_id][] used for filtering Annotations for training.

Only used for custom training data export use cases. Only applicable to Datasets that have SavedQueries.

Only Annotations that are associated with this SavedQuery are used in respectively training. When used in conjunction with annotations_filter, the Annotations used for training are filtered by both saved_query_id and annotations_filter.

Only one of saved_query_id and annotation_schema_uri should be specified as both of them represent the same thing: problem type.

string saved_query_id = 11;

Returns
TypeDescription
ByteString

The bytes for savedQueryId.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSplitCase()

public ExportDataConfig.SplitCase getSplitCase()
Returns
TypeDescription
ExportDataConfig.SplitCase

hasFilterSplit()

public boolean hasFilterSplit()

Split based on the provided filters for each set.

.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;

Returns
TypeDescription
boolean

Whether the filterSplit field is set.

hasFractionSplit()

public boolean hasFractionSplit()

Split based on fractions defining the size of each set.

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

Returns
TypeDescription
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.v1.GcsDestination gcs_destination = 1;

Returns
TypeDescription
boolean

Whether the gcsDestination field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExportDataConfig.Builder newBuilderForType()
Returns
TypeDescription
ExportDataConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportDataConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExportDataConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExportDataConfig.Builder toBuilder()
Returns
TypeDescription
ExportDataConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException