Package com.google.cloud.aiplatform.v1

Class ExportDataConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ExportDataConfig
All Implemented Interfaces:
ExportDataConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ExportDataConfig extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • GCS_DESTINATION_FIELD_NUMBER

      public static final int GCS_DESTINATION_FIELD_NUMBER
      See Also:

    • FRACTION_SPLIT_FIELD_NUMBER

      public static final int FRACTION_SPLIT_FIELD_NUMBER
      See Also:

    • FILTER_SPLIT_FIELD_NUMBER

      public static final int FILTER_SPLIT_FIELD_NUMBER
      See Also:

    • ANNOTATIONS_FILTER_FIELD_NUMBER

      public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
      See Also:

    • SAVED_QUERY_ID_FIELD_NUMBER

      public static final int SAVED_QUERY_ID_FIELD_NUMBER
      See Also:

    • ANNOTATION_SCHEMA_URI_FIELD_NUMBER

      public static final int ANNOTATION_SCHEMA_URI_FIELD_NUMBER
      See Also:

    • EXPORT_USE_FIELD_NUMBER

      public static final int EXPORT_USE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDestinationCase

      public ExportDataConfig.DestinationCase getDestinationCase()
      Specified by:
      getDestinationCase in interface ExportDataConfigOrBuilder

    • getSplitCase

      public ExportDataConfig.SplitCase getSplitCase()
      Specified by:
      getSplitCase in interface ExportDataConfigOrBuilder

    • 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;
      Specified by:
      hasGcsDestination in interface ExportDataConfigOrBuilder
      Returns:
      Whether the gcsDestination field is set.

    • 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;
      Specified by:
      getGcsDestination in interface ExportDataConfigOrBuilder
      Returns:
      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;
      Specified by:
      getGcsDestinationOrBuilder in interface ExportDataConfigOrBuilder

    • hasFractionSplit

      public boolean hasFractionSplit()
       Split based on fractions defining the size of each set.
      .google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
      Specified by:
      hasFractionSplit in interface ExportDataConfigOrBuilder
      Returns:
      Whether the fractionSplit field is set.

    • getFractionSplit

      public ExportFractionSplit getFractionSplit()
       Split based on fractions defining the size of each set.
      .google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
      Specified by:
      getFractionSplit in interface ExportDataConfigOrBuilder
      Returns:
      The fractionSplit.

    • getFractionSplitOrBuilder

      public ExportFractionSplitOrBuilder getFractionSplitOrBuilder()
       Split based on fractions defining the size of each set.
      .google.cloud.aiplatform.v1.ExportFractionSplit fraction_split = 5;
      Specified by:
      getFractionSplitOrBuilder in interface ExportDataConfigOrBuilder

    • hasFilterSplit

      public boolean hasFilterSplit()
       Split based on the provided filters for each set.
      .google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
      Specified by:
      hasFilterSplit in interface ExportDataConfigOrBuilder
      Returns:
      Whether the filterSplit field is set.

    • getFilterSplit

      public ExportFilterSplit getFilterSplit()
       Split based on the provided filters for each set.
      .google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
      Specified by:
      getFilterSplit in interface ExportDataConfigOrBuilder
      Returns:
      The filterSplit.

    • getFilterSplitOrBuilder

      public ExportFilterSplitOrBuilder getFilterSplitOrBuilder()
       Split based on the provided filters for each set.
      .google.cloud.aiplatform.v1.ExportFilterSplit filter_split = 7;
      Specified by:
      getFilterSplitOrBuilder in interface ExportDataConfigOrBuilder

    • 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][google.cloud.aiplatform.v1.DatasetService.ListAnnotations].
      string annotations_filter = 2;
      Specified by:
      getAnnotationsFilter in interface ExportDataConfigOrBuilder
      Returns:
      The annotationsFilter.

    • getAnnotationsFilterBytes

      public 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;
      Specified by:
      getAnnotationsFilterBytes in interface ExportDataConfigOrBuilder
      Returns:
      The bytes for annotationsFilter.

    • getSavedQueryId

      public 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;
      Specified by:
      getSavedQueryId in interface ExportDataConfigOrBuilder
      Returns:
      The savedQueryId.

    • getSavedQueryIdBytes

      public 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;
      Specified by:
      getSavedQueryIdBytes in interface ExportDataConfigOrBuilder
      Returns:
      The bytes for savedQueryId.

    • 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](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;
      Specified by:
      getAnnotationSchemaUri in interface ExportDataConfigOrBuilder
      Returns:
      The annotationSchemaUri.

    • getAnnotationSchemaUriBytes

      public 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;
      Specified by:
      getAnnotationSchemaUriBytes in interface ExportDataConfigOrBuilder
      Returns:
      The bytes for annotationSchemaUri.

    • getExportUseValue

      public int getExportUseValue()
       Indicates the usage of the exported files.
      .google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;
      Specified by:
      getExportUseValue in interface ExportDataConfigOrBuilder
      Returns:
      The enum numeric value on the wire for exportUse.

    • getExportUse

      public ExportDataConfig.ExportUse getExportUse()
       Indicates the usage of the exported files.
      .google.cloud.aiplatform.v1.ExportDataConfig.ExportUse export_use = 4;
      Specified by:
      getExportUse in interface ExportDataConfigOrBuilder
      Returns:
      The exportUse.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ExportDataConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ExportDataConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDataConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDataConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ExportDataConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDataConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ExportDataConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ExportDataConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ExportDataConfig.Builder newBuilder()

    • newBuilder

      public static ExportDataConfig.Builder newBuilder(ExportDataConfig prototype)

    • toBuilder

      public ExportDataConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ExportDataConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ExportDataConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ExportDataConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<ExportDataConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ExportDataConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder