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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ANNOTATION_SCHEMA_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int EXPORT_USE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILTER_SPLIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FRACTION_SPLIT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GCS_DESTINATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SAVED_QUERY_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static ExportDataConfig getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static ExportDataConfig.Builder newBuilder()
public static ExportDataConfig.Builder newBuilder(ExportDataConfig prototype)
public static ExportDataConfig parseDelimitedFrom(InputStream input)
public static ExportDataConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDataConfig parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static ExportDataConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportDataConfig parseFrom(ByteString data)
public static ExportDataConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportDataConfig parseFrom(CodedInputStream input)
public static ExportDataConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDataConfig parseFrom(InputStream input)
public static ExportDataConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportDataConfig parseFrom(ByteBuffer data)
public static ExportDataConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<ExportDataConfig> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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
ExportDataRequest.name.
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 |
| Type |
Description |
String |
The annotationSchemaUri.
|
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
ExportDataRequest.name.
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 |
| Type |
Description |
ByteString |
The bytes for annotationSchemaUri.
|
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.
|
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.
|
public ExportDataConfig getDefaultInstanceForType()
public ExportDataConfig.DestinationCase getDestinationCase()
public ExportDataConfig.ExportUse getExportUse()
Indicates the usage of the exported files.
.google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;
public int getExportUseValue()
Indicates the usage of the exported files.
.google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for exportUse.
|
public ExportFilterSplit getFilterSplit()
Split based on the provided filters for each set.
.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
public ExportFilterSplitOrBuilder getFilterSplitOrBuilder()
Split based on the provided filters for each set.
.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
public ExportFractionSplit getFractionSplit()
Split based on fractions defining the size of each set.
.google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
public ExportFractionSplitOrBuilder getFractionSplitOrBuilder()
Split based on fractions defining the size of each set.
.google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
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;
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;
public Parser<ExportDataConfig> getParserForType()
Overrides
public String getSavedQueryId()
The ID of a SavedQuery (annotation set) under the Dataset specified by
ExportDataRequest.name
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 |
| Type |
Description |
String |
The savedQueryId.
|
public ByteString getSavedQueryIdBytes()
The ID of a SavedQuery (annotation set) under the Dataset specified by
ExportDataRequest.name
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 |
| Type |
Description |
ByteString |
The bytes for savedQueryId.
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public ExportDataConfig.SplitCase getSplitCase()
public boolean hasFilterSplit()
Split based on the provided filters for each set.
.google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
| Returns |
| Type |
Description |
boolean |
Whether the filterSplit field is set.
|
public boolean hasFractionSplit()
Split based on fractions defining the size of each set.
.google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
| Returns |
| Type |
Description |
boolean |
Whether the fractionSplit field is set.
|
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 |
| Type |
Description |
boolean |
Whether the gcsDestination field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public ExportDataConfig.Builder newBuilderForType()
protected ExportDataConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public ExportDataConfig.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
