Class ExportDataRequest (0.162.0)

public final class ExportDataRequest extends GeneratedMessageV3 implements ExportDataRequestOrBuilder

Request message for ExportData API.

Protobuf type google.cloud.datalabeling.v1beta1.ExportDataRequest

Static Fields

ANNOTATED_DATASET_FIELD_NUMBER

public static final int ANNOTATED_DATASET_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_CONFIG_FIELD_NUMBER

public static final int OUTPUT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

USER_EMAIL_ADDRESS_FIELD_NUMBER

public static final int USER_EMAIL_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExportDataRequest getDefaultInstance()
Returns
Type Description
ExportDataRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ExportDataRequest.Builder newBuilder()
Returns
Type Description
ExportDataRequest.Builder

newBuilder(ExportDataRequest prototype)

public static ExportDataRequest.Builder newBuilder(ExportDataRequest prototype)
Parameter
Name Description
prototype ExportDataRequest
Returns
Type Description
ExportDataRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExportDataRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExportDataRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportDataRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportDataRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExportDataRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExportDataRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportDataRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExportDataRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExportDataRequest> parser()
Returns
Type Description
Parser<ExportDataRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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) = { ... }

Returns
Type Description
String

The annotatedDataset.

getAnnotatedDatasetBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for annotatedDataset.

getDefaultInstanceForType()

public ExportDataRequest getDefaultInstanceForType()
Returns
Type Description
ExportDataRequest

getFilter()

public String getFilter()

Optional. Filter is not supported at this moment.

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter is not supported at this moment.

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

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) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public 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) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getOutputConfig()

public OutputConfig getOutputConfig()

Required. Specify the output destination.

.google.cloud.datalabeling.v1beta1.OutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfig

The outputConfig.

getOutputConfigOrBuilder()

public OutputConfigOrBuilder getOutputConfigOrBuilder()

Required. Specify the output destination.

.google.cloud.datalabeling.v1beta1.OutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputConfigOrBuilder

getParserForType()

public Parser<ExportDataRequest> getParserForType()
Returns
Type Description
Parser<ExportDataRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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;

Returns
Type Description
String

The userEmailAddress.

getUserEmailAddressBytes()

public 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;

Returns
Type Description
ByteString

The bytes for userEmailAddress.

hasOutputConfig()

public boolean hasOutputConfig()

Required. Specify the output destination.

.google.cloud.datalabeling.v1beta1.OutputConfig output_config = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the outputConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ExportDataRequest.Builder newBuilderForType()
Returns
Type Description
ExportDataRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportDataRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExportDataRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ExportDataRequest.Builder toBuilder()
Returns
Type Description
ExportDataRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException