Class DataLabelingJob (3.8.0)

Version 3.8.0

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class DataLabelingJob extends GeneratedMessageV3 implements DataLabelingJobOrBuilder

DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

Protobuf type google.cloud.aiplatform.v1.DataLabelingJob

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataLabelingJob

Implements

DataLabelingJobOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACTIVE_LEARNING_CONFIG_FIELD_NUMBER

public static final int ACTIVE_LEARNING_CONFIG_FIELD_NUMBER

Field Value

Type	Description
int

ANNOTATION_LABELS_FIELD_NUMBER

public static final int ANNOTATION_LABELS_FIELD_NUMBER

Field Value

Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

CURRENT_SPEND_FIELD_NUMBER

public static final int CURRENT_SPEND_FIELD_NUMBER

Field Value

Type	Description
int

DATASETS_FIELD_NUMBER

public static final int DATASETS_FIELD_NUMBER

Field Value

Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value

Type	Description
int

ENCRYPTION_SPEC_FIELD_NUMBER

public static final int ENCRYPTION_SPEC_FIELD_NUMBER

Field Value

Type	Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER

Field Value

Type	Description
int

INPUTS_FIELD_NUMBER

public static final int INPUTS_FIELD_NUMBER

Field Value

Type	Description
int

INPUTS_SCHEMA_URI_FIELD_NUMBER

public static final int INPUTS_SCHEMA_URI_FIELD_NUMBER

Field Value

Type	Description
int

INSTRUCTION_URI_FIELD_NUMBER

public static final int INSTRUCTION_URI_FIELD_NUMBER

Field Value

Type	Description
int

LABELER_COUNT_FIELD_NUMBER

public static final int LABELER_COUNT_FIELD_NUMBER

Field Value

Type	Description
int

LABELING_PROGRESS_FIELD_NUMBER

public static final int LABELING_PROGRESS_FIELD_NUMBER

Field Value

Type	Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

Field Value

Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value

Type	Description
int

SPECIALIST_POOLS_FIELD_NUMBER

public static final int SPECIALIST_POOLS_FIELD_NUMBER

Field Value

Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value

Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value

Type	Description
int

Static Methods

getDefaultInstance()

public static DataLabelingJob getDefaultInstance()

Returns

Type	Description
DataLabelingJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static DataLabelingJob.Builder newBuilder()

Returns

Type	Description
DataLabelingJob.Builder

newBuilder(DataLabelingJob prototype)

public static DataLabelingJob.Builder newBuilder(DataLabelingJob prototype)

Parameter

Name	Description
prototype	DataLabelingJob

Returns

Type	Description
DataLabelingJob.Builder

parseDelimitedFrom(InputStream input)

public static DataLabelingJob parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static DataLabelingJob parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataLabelingJob parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataLabelingJob parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static DataLabelingJob parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static DataLabelingJob parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataLabelingJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
DataLabelingJob

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DataLabelingJob> parser()

Returns

Type	Description
Parser<DataLabelingJob>

Methods

containsAnnotationLabels(String key)

public boolean containsAnnotationLabels(String key)

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> annotation_labels = 12;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

containsLabels(String key)

public boolean containsLabels(String key)

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

• "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

map<string, string> labels = 11;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getActiveLearningConfig()

public ActiveLearningConfig getActiveLearningConfig()

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

.google.cloud.aiplatform.v1.ActiveLearningConfig active_learning_config = 21;

Returns

Type	Description
ActiveLearningConfig	The activeLearningConfig.

getActiveLearningConfigOrBuilder()

public ActiveLearningConfigOrBuilder getActiveLearningConfigOrBuilder()

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

.google.cloud.aiplatform.v1.ActiveLearningConfig active_learning_config = 21;

Returns

Type	Description
ActiveLearningConfigOrBuilder

getAnnotationLabels()

public Map<String,String> getAnnotationLabels()

Use #getAnnotationLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getAnnotationLabelsCount()

public int getAnnotationLabelsCount()

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> annotation_labels = 12;

Returns

Type	Description
int

getAnnotationLabelsMap()

public Map<String,String> getAnnotationLabelsMap()

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> annotation_labels = 12;

Returns

Type	Description
Map<String,String>

getAnnotationLabelsOrDefault(String key, String defaultValue)

public String getAnnotationLabelsOrDefault(String key, String defaultValue)

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> annotation_labels = 12;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getAnnotationLabelsOrThrow(String key)

public String getAnnotationLabelsOrThrow(String key)

Labels to assign to annotations generated by this DataLabelingJob. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

map<string, string> annotation_labels = 12;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this DataLabelingJob was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this DataLabelingJob was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getCurrentSpend()

public Money getCurrentSpend()

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

.google.type.Money current_spend = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
com.google.type.Money	The currentSpend.

getCurrentSpendOrBuilder()

public MoneyOrBuilder getCurrentSpendOrBuilder()

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

.google.type.Money current_spend = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
com.google.type.MoneyOrBuilder

getDatasets(int index)

public String getDatasets(int index)

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The datasets at the given index.

getDatasetsBytes(int index)

public ByteString getDatasetsBytes(int index)

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the datasets at the given index.

getDatasetsCount()

public int getDatasetsCount()

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
int	The count of datasets.

getDatasetsList()

public ProtocolStringList getDatasetsList()

Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}

repeated string datasets = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ProtocolStringList	A list containing the datasets.

getDefaultInstanceForType()

public DataLabelingJob getDefaultInstanceForType()

Returns

Type	Description
DataLabelingJob

getDisplayName()

public String getDisplayName()

Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The user-defined name of the DataLabelingJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a DataLabelingJob.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for displayName.

getEncryptionSpec()

public EncryptionSpec getEncryptionSpec()

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key. Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 20;

Returns

Type	Description
EncryptionSpec	The encryptionSpec.

getEncryptionSpecOrBuilder()

public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key. Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 20;

Returns

Type	Description
EncryptionSpecOrBuilder

getError()

public Status getError()

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
com.google.rpc.Status	The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
com.google.rpc.StatusOrBuilder

getInputs()

public Value getInputs()

Required. Input config parameters for the DataLabelingJob.

.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Value	The inputs.

getInputsOrBuilder()

public ValueOrBuilder getInputsOrBuilder()

Required. Input config parameters for the DataLabelingJob.

.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ValueOrBuilder

getInputsSchemaUri()

public String getInputsSchemaUri()

Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.

string inputs_schema_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The inputsSchemaUri.

getInputsSchemaUriBytes()

public ByteString getInputsSchemaUriBytes()

Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder.

string inputs_schema_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for inputsSchemaUri.

getInstructionUri()

public String getInstructionUri()

Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.

string instruction_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The instructionUri.

getInstructionUriBytes()

public ByteString getInstructionUriBytes()

Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets.

string instruction_uri = 5 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for instructionUri.

getLabelerCount()

public int getLabelerCount()

Required. Number of labelers to work on each DataItem.

int32 labeler_count = 4 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
int	The labelerCount.

getLabelingProgress()

public int getLabelingProgress()

Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished.

int32 labeling_progress = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The labelingProgress.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

• "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

map<string, string> labels = 11;

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

• "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

map<string, string> labels = 11;

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

• "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

map<string, string> labels = 11;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

The labels with user-defined metadata to organize your DataLabelingJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for each DataLabelingJob:

• "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title.

map<string, string> labels = 11;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getName()

public String getName()

Output only. Resource name of the DataLabelingJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of the DataLabelingJob.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for name.

getParserForType()

public Parser<DataLabelingJob> getParserForType()

Returns

Type	Description
Parser<DataLabelingJob>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSpecialistPools(int index)

public String getSpecialistPools(int index)

The SpecialistPools' resource names associated with this job.

repeated string specialist_pools = 16;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The specialistPools at the given index.

getSpecialistPoolsBytes(int index)

public ByteString getSpecialistPoolsBytes(int index)

The SpecialistPools' resource names associated with this job.

repeated string specialist_pools = 16;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the specialistPools at the given index.

getSpecialistPoolsCount()

public int getSpecialistPoolsCount()

The SpecialistPools' resource names associated with this job.

repeated string specialist_pools = 16;

Returns

Type	Description
int	The count of specialistPools.

getSpecialistPoolsList()

public ProtocolStringList getSpecialistPoolsList()

The SpecialistPools' resource names associated with this job.

repeated string specialist_pools = 16;

Returns

Type	Description
ProtocolStringList	A list containing the specialistPools.

getState()

public JobState getState()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
JobState	The state.

getStateValue()

public int getStateValue()

Output only. The detailed state of the job.

.google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
int	The enum numeric value on the wire for state.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this DataLabelingJob was updated most recently.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this DataLabelingJob was updated most recently.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

hasActiveLearningConfig()

public boolean hasActiveLearningConfig()

Parameters that configure the active learning pipeline. Active learning will label the data incrementally via several iterations. For every iteration, it will select a batch of data based on the sampling strategy.

.google.cloud.aiplatform.v1.ActiveLearningConfig active_learning_config = 21;

Returns

Type	Description
boolean	Whether the activeLearningConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this DataLabelingJob was created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the createTime field is set.

hasCurrentSpend()

public boolean hasCurrentSpend()

Output only. Estimated cost(in US dollars) that the DataLabelingJob has incurred to date.

.google.type.Money current_spend = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the currentSpend field is set.

hasEncryptionSpec()

public boolean hasEncryptionSpec()

Customer-managed encryption key spec for a DataLabelingJob. If set, this DataLabelingJob will be secured by this key. Note: Annotations created in the DataLabelingJob are associated with the EncryptionSpec of the Dataset they are exported to.

.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 20;

Returns

Type	Description
boolean	Whether the encryptionSpec field is set.

hasError()

public boolean hasError()

Output only. DataLabelingJob errors. It is only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

.google.rpc.Status error = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the error field is set.

hasInputs()

public boolean hasInputs()

Required. Input config parameters for the DataLabelingJob.

.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the inputs field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this DataLabelingJob was updated most recently.

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DataLabelingJob.Builder newBuilderForType()

Returns

Type	Description
DataLabelingJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataLabelingJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
DataLabelingJob.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DataLabelingJob.Builder toBuilder()

Returns

Type	Description
DataLabelingJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException