Class ExportDataRequest

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

    public final class ExportDataRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements ExportDataRequestOrBuilder
     Request message for ExportData API.
     
    Protobuf type google.cloud.datalabeling.v1beta1.ExportDataRequest
    See Also:
    Serialized Form
    • Field Detail

      • ANNOTATED_DATASET_FIELD_NUMBER

        public static final int ANNOTATED_DATASET_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OUTPUT_CONFIG_FIELD_NUMBER

        public static final int OUTPUT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values
      • USER_EMAIL_ADDRESS_FIELD_NUMBER

        public static final int USER_EMAIL_ADDRESS_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
      • getName

        public String getName()
         Required. Dataset resource name, format:
         projects/{project_id}/datasets/{dataset_id}
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getName in interface ExportDataRequestOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Required. Dataset resource name, format:
         projects/{project_id}/datasets/{dataset_id}
         
        string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getNameBytes in interface ExportDataRequestOrBuilder
        Returns:
        The bytes for name.
      • getAnnotatedDataset

        public String getAnnotatedDataset()
         Required. Annotated dataset resource name. DataItem in
         Dataset and their annotations in specified annotated dataset will be
         exported. It's in format of
         projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
         {annotated_dataset_id}
         
        string annotated_dataset = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getAnnotatedDataset in interface ExportDataRequestOrBuilder
        Returns:
        The annotatedDataset.
      • getAnnotatedDatasetBytes

        public com.google.protobuf.ByteString getAnnotatedDatasetBytes()
         Required. Annotated dataset resource name. DataItem in
         Dataset and their annotations in specified annotated dataset will be
         exported. It's in format of
         projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/
         {annotated_dataset_id}
         
        string annotated_dataset = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getAnnotatedDatasetBytes in interface ExportDataRequestOrBuilder
        Returns:
        The bytes for annotatedDataset.
      • getFilter

        public String getFilter()
         Optional. Filter is not supported at this moment.
         
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilter in interface ExportDataRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         Optional. Filter is not supported at this moment.
         
        string filter = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFilterBytes in interface ExportDataRequestOrBuilder
        Returns:
        The bytes for filter.
      • hasOutputConfig

        public boolean hasOutputConfig()
         Required. Specify the output destination.
         
        .google.cloud.datalabeling.v1beta1.OutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasOutputConfig in interface ExportDataRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.
      • getOutputConfig

        public OutputConfig getOutputConfig()
         Required. Specify the output destination.
         
        .google.cloud.datalabeling.v1beta1.OutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getOutputConfig in interface ExportDataRequestOrBuilder
        Returns:
        The outputConfig.
      • getUserEmailAddress

        public String getUserEmailAddress()
         Email of the user who started the export task and should be notified by
         email. If empty no notification will be sent.
         
        string user_email_address = 5;
        Specified by:
        getUserEmailAddress in interface ExportDataRequestOrBuilder
        Returns:
        The userEmailAddress.
      • getUserEmailAddressBytes

        public com.google.protobuf.ByteString getUserEmailAddressBytes()
         Email of the user who started the export task and should be notified by
         email. If empty no notification will be sent.
         
        string user_email_address = 5;
        Specified by:
        getUserEmailAddressBytes in interface ExportDataRequestOrBuilder
        Returns:
        The bytes for userEmailAddress.
      • 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 ExportDataRequest parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static ExportDataRequest parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        public static ExportDataRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected ExportDataRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<ExportDataRequest> 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 ExportDataRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder