com.google.cloud.aiplatform.v1

Interface ExportDataConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ExportDataConfig, ExportDataConfig.Builder

public interface ExportDataConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAnnotationSchemaUri() The Cloud Storage URI that points to a YAML file describing the annotation schema.
com.google.protobuf.ByteString	getAnnotationSchemaUriBytes() The Cloud Storage URI that points to a YAML file describing the annotation schema.
String	getAnnotationsFilter() An expression for filtering what part of the Dataset is to be exported.
com.google.protobuf.ByteString	getAnnotationsFilterBytes() An expression for filtering what part of the Dataset is to be exported.
ExportDataConfig.DestinationCase	getDestinationCase()
ExportDataConfig.ExportUse	getExportUse() Indicates the usage of the exported files.
int	getExportUseValue() Indicates the usage of the exported files.
ExportFilterSplit	getFilterSplit() Split based on the provided filters for each set.
ExportFilterSplitOrBuilder	getFilterSplitOrBuilder() Split based on the provided filters for each set.
ExportFractionSplit	getFractionSplit() Split based on fractions defining the size of each set.
ExportFractionSplitOrBuilder	getFractionSplitOrBuilder() Split based on fractions defining the size of each set.
GcsDestination	getGcsDestination() The Google Cloud Storage location where the output is to be written to.
GcsDestinationOrBuilder	getGcsDestinationOrBuilder() The Google Cloud Storage location where the output is to be written to.
String	getSavedQueryId() The ID of a SavedQuery (annotation set) under the Dataset specified by [ExportDataRequest.name][google.cloud.aiplatform.v1.ExportDataRequest.name] used for filtering Annotations for training.
com.google.protobuf.ByteString	getSavedQueryIdBytes() The ID of a SavedQuery (annotation set) under the Dataset specified by [ExportDataRequest.name][google.cloud.aiplatform.v1.ExportDataRequest.name] used for filtering Annotations for training.
ExportDataConfig.SplitCase	getSplitCase()
boolean	hasFilterSplit() Split based on the provided filters for each set.
boolean	hasFractionSplit() Split based on fractions defining the size of each set.
boolean	hasGcsDestination() The Google Cloud Storage location where the output is to be written to.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasGcsDestination

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:

Whether the gcsDestination field is set.

getGcsDestination

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:

The gcsDestination.

getGcsDestinationOrBuilder

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;

hasFractionSplit

boolean hasFractionSplit()

 Split based on fractions defining the size of each set.
 

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

Returns:

Whether the fractionSplit field is set.

getFractionSplit

ExportFractionSplit getFractionSplit()

 Split based on fractions defining the size of each set.
 

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

Returns:

The fractionSplit.

getFractionSplitOrBuilder

ExportFractionSplitOrBuilder getFractionSplitOrBuilder()

 Split based on fractions defining the size of each set.
 

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

hasFilterSplit

boolean hasFilterSplit()

 Split based on the provided filters for each set.
 

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

Returns:

Whether the filterSplit field is set.

getFilterSplit

ExportFilterSplit getFilterSplit()

 Split based on the provided filters for each set.
 

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

Returns:

The filterSplit.

getFilterSplitOrBuilder

ExportFilterSplitOrBuilder getFilterSplitOrBuilder()

 Split based on the provided filters for each set.
 

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

getAnnotationsFilter

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][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
 

string annotations_filter = 2;

Returns:

The annotationsFilter.

getAnnotationsFilterBytes

com.google.protobuf.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][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
 

string annotations_filter = 2;

Returns:

The bytes for annotationsFilter.

getSavedQueryId

String getSavedQueryId()

 The ID of a SavedQuery (annotation set) under the Dataset specified by
 [ExportDataRequest.name][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
 the Annotations used for training are filtered by both
 [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
 and
 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].

 Only one of
 [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
 and
 [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri]
 should be specified as both of them represent the same thing: problem type.
 

string saved_query_id = 11;

Returns:

The savedQueryId.

getSavedQueryIdBytes

com.google.protobuf.ByteString getSavedQueryIdBytes()

 The ID of a SavedQuery (annotation set) under the Dataset specified by
 [ExportDataRequest.name][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
 the Annotations used for training are filtered by both
 [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
 and
 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter].

 Only one of
 [saved_query_id][google.cloud.aiplatform.v1.ExportDataConfig.saved_query_id]
 and
 [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri]
 should be specified as both of them represent the same thing: problem type.
 

string saved_query_id = 11;

Returns:

The bytes for savedQueryId.

getAnnotationSchemaUri

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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
 Dataset specified by
 [ExportDataRequest.name][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
 the Annotations used for training are filtered by both
 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter]
 and
 [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].
 

string annotation_schema_uri = 12;

Returns:

The annotationSchemaUri.

getAnnotationSchemaUriBytes

com.google.protobuf.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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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][google.cloud.aiplatform.v1.Dataset.metadata_schema_uri] of the
 Dataset specified by
 [ExportDataRequest.name][google.cloud.aiplatform.v1.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][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter],
 the Annotations used for training are filtered by both
 [annotations_filter][google.cloud.aiplatform.v1.ExportDataConfig.annotations_filter]
 and
 [annotation_schema_uri][google.cloud.aiplatform.v1.ExportDataConfig.annotation_schema_uri].
 

string annotation_schema_uri = 12;

Returns:

The bytes for annotationSchemaUri.

getExportUseValue

int getExportUseValue()

 Indicates the usage of the exported files.
 

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

Returns:

The enum numeric value on the wire for exportUse.

getExportUse

ExportDataConfig.ExportUse getExportUse()

 Indicates the usage of the exported files.
 

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

Returns:

The exportUse.

getDestinationCase

ExportDataConfig.DestinationCase getDestinationCase()

getSplitCase

ExportDataConfig.SplitCase getSplitCase()