Interface ExportDataConfigOrBuilder (3.34.0)

Version 3.34.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface ExportDataConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotationSchemaUri()

public abstract 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
Type	Description
String	The annotationSchemaUri.

getAnnotationSchemaUriBytes()

public abstract 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
Type	Description
ByteString	The bytes for annotationSchemaUri.

getAnnotationsFilter()

public abstract 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 abstract 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.

getDestinationCase()

public abstract ExportDataConfig.DestinationCase getDestinationCase()

Returns
Type	Description
ExportDataConfig.DestinationCase

getExportUse()

public abstract ExportDataConfig.ExportUse getExportUse()

Indicates the usage of the exported files.

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

Returns
Type	Description
ExportDataConfig.ExportUse	The exportUse.

getExportUseValue()

public abstract 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.

getFilterSplit()

public abstract ExportFilterSplit getFilterSplit()

Split based on the provided filters for each set.

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

Returns
Type	Description
ExportFilterSplit	The filterSplit.

getFilterSplitOrBuilder()

public abstract ExportFilterSplitOrBuilder getFilterSplitOrBuilder()

Split based on the provided filters for each set.

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

Returns
Type	Description
ExportFilterSplitOrBuilder

getFractionSplit()

public abstract ExportFractionSplit getFractionSplit()

Split based on fractions defining the size of each set.

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

Returns
Type	Description
ExportFractionSplit	The fractionSplit.

getFractionSplitOrBuilder()

public abstract ExportFractionSplitOrBuilder getFractionSplitOrBuilder()

Split based on fractions defining the size of each set.

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

Returns
Type	Description
ExportFractionSplitOrBuilder

getGcsDestination()

public abstract 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
Type	Description
GcsDestination	The gcsDestination.

getGcsDestinationOrBuilder()

public abstract 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
Type	Description
GcsDestinationOrBuilder

getSavedQueryId()

public abstract 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
Type	Description
String	The savedQueryId.

getSavedQueryIdBytes()

public abstract 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
Type	Description
ByteString	The bytes for savedQueryId.

getSplitCase()

public abstract ExportDataConfig.SplitCase getSplitCase()

Returns
Type	Description
ExportDataConfig.SplitCase

hasFilterSplit()

public abstract 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.

hasFractionSplit()

public abstract 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.

hasGcsDestination()

public abstract 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.