Class Dataset (0.165.0)

public final class Dataset extends GeneratedMessageV3 implements DatasetOrBuilder

Dataset is the resource to hold your data. You can request multiple labeling tasks for a dataset while each one will generate an AnnotatedDataset.

Protobuf type google.cloud.datalabeling.v1beta1.Dataset

Implements

DatasetOrBuilder

Static Fields

BLOCKING_RESOURCES_FIELD_NUMBER

public static final int BLOCKING_RESOURCES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_ITEM_COUNT_FIELD_NUMBER

public static final int DATA_ITEM_COUNT_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

INPUT_CONFIGS_FIELD_NUMBER

public static final int INPUT_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Dataset getDefaultInstance()
Returns
Type Description
Dataset

getDescriptor()

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

newBuilder()

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

newBuilder(Dataset prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBlockingResources(int index)

public String getBlockingResources(int index)

Output only. The names of any related resources that are blocking changes to the dataset.

repeated string blocking_resources = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The blockingResources at the given index.

getBlockingResourcesBytes(int index)

public ByteString getBlockingResourcesBytes(int index)

Output only. The names of any related resources that are blocking changes to the dataset.

repeated string blocking_resources = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the blockingResources at the given index.

getBlockingResourcesCount()

public int getBlockingResourcesCount()

Output only. The names of any related resources that are blocking changes to the dataset.

repeated string blocking_resources = 6;

Returns
Type Description
int

The count of blockingResources.

getBlockingResourcesList()

public ProtocolStringList getBlockingResourcesList()

Output only. The names of any related resources that are blocking changes to the dataset.

repeated string blocking_resources = 6;

Returns
Type Description
ProtocolStringList

A list containing the blockingResources.

getCreateTime()

public Timestamp getCreateTime()

Output only. Time the dataset is created.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time the dataset is created.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
TimestampOrBuilder

getDataItemCount()

public long getDataItemCount()

Output only. The number of data items in the dataset.

int64 data_item_count = 7;

Returns
Type Description
long

The dataItemCount.

getDefaultInstanceForType()

public Dataset getDefaultInstanceForType()
Returns
Type Description
Dataset

getDescription()

public String getDescription()

Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Required. The display name of the dataset. Maximum of 64 characters.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the dataset. Maximum of 64 characters.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getInputConfigs(int index)

public InputConfig getInputConfigs(int index)

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
InputConfig

getInputConfigsCount()

public int getInputConfigsCount()

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
int

getInputConfigsList()

public List<InputConfig> getInputConfigsList()

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
List<InputConfig>

getInputConfigsOrBuilder(int index)

public InputConfigOrBuilder getInputConfigsOrBuilder(int index)

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;

Parameter
Name Description
index int
Returns
Type Description
InputConfigOrBuilder

getInputConfigsOrBuilderList()

public List<? extends InputConfigOrBuilder> getInputConfigsOrBuilderList()

Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset.

repeated .google.cloud.datalabeling.v1beta1.InputConfig input_configs = 5;

Returns
Type Description
List<? extends com.google.cloud.datalabeling.v1beta1.InputConfigOrBuilder>

getName()

public String getName()

Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id}

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

Output only. Time the dataset is created.

.google.protobuf.Timestamp create_time = 4;

Returns
Type Description
boolean

Whether the createTime 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 Dataset.Builder newBuilderForType()
Returns
Type Description
Dataset.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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