Class ExportDataConfig

  • All Implemented Interfaces:
    ExportDataConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class ExportDataConfig
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Field Detail

      • GCS_DESTINATION_FIELD_NUMBER

        public static final int GCS_DESTINATION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FRACTION_SPLIT_FIELD_NUMBER

        public static final int FRACTION_SPLIT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ANNOTATIONS_FILTER_FIELD_NUMBER

        public static final int ANNOTATIONS_FILTER_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • 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.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • 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​(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
      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • 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.GeneratedMessageV3
      • getDefaultInstanceForType

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