DataLabelingJob (proto-google-cloud-aiplatform-v1 3.42.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1.DataLabelingJob

All Implemented Interfaces:

DataLabelingJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class DataLabelingJob
extends com.google.protobuf.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
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataLabelingJob.Builder` DataLabelingJob is used to trigger a human labeling job on unlabeled data from the following Dataset:

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACTIVE_LEARNING_CONFIG_FIELD_NUMBER`
`static int`	`ANNOTATION_LABELS_FIELD_NUMBER`
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`CURRENT_SPEND_FIELD_NUMBER`
`static int`	`DATASETS_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ENCRYPTION_SPEC_FIELD_NUMBER`
`static int`	`ERROR_FIELD_NUMBER`
`static int`	`INPUTS_FIELD_NUMBER`
`static int`	`INPUTS_SCHEMA_URI_FIELD_NUMBER`
`static int`	`INSTRUCTION_URI_FIELD_NUMBER`
`static int`	`LABELER_COUNT_FIELD_NUMBER`
`static int`	`LABELING_PROGRESS_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`SPECIALIST_POOLS_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsAnnotationLabels(String key)` Labels to assign to annotations generated by this DataLabelingJob.
`boolean`	`containsLabels(String key)` The labels with user-defined metadata to organize your DataLabelingJobs.
`boolean`	`equals(Object obj)`
`ActiveLearningConfig`	`getActiveLearningConfig()` Parameters that configure the active learning pipeline.
`ActiveLearningConfigOrBuilder`	`getActiveLearningConfigOrBuilder()` Parameters that configure the active learning pipeline.
`Map<String,String>`	`getAnnotationLabels()` Deprecated.
`int`	`getAnnotationLabelsCount()` Labels to assign to annotations generated by this DataLabelingJob.
`Map<String,String>`	`getAnnotationLabelsMap()` Labels to assign to annotations generated by this DataLabelingJob.
`String`	`getAnnotationLabelsOrDefault(String key, String defaultValue)` Labels to assign to annotations generated by this DataLabelingJob.
`String`	`getAnnotationLabelsOrThrow(String key)` Labels to assign to annotations generated by this DataLabelingJob.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`com.google.type.Money`	`getCurrentSpend()` Output only.
`com.google.type.MoneyOrBuilder`	`getCurrentSpendOrBuilder()` Output only.
`String`	`getDatasets(int index)` Required.
`com.google.protobuf.ByteString`	`getDatasetsBytes(int index)` Required.
`int`	`getDatasetsCount()` Required.
`com.google.protobuf.ProtocolStringList`	`getDatasetsList()` Required.
`static DataLabelingJob`	`getDefaultInstance()`
`DataLabelingJob`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`EncryptionSpec`	`getEncryptionSpec()` Customer-managed encryption key spec for a DataLabelingJob.
`EncryptionSpecOrBuilder`	`getEncryptionSpecOrBuilder()` Customer-managed encryption key spec for a DataLabelingJob.
`com.google.rpc.Status`	`getError()` Output only.
`com.google.rpc.StatusOrBuilder`	`getErrorOrBuilder()` Output only.
`com.google.protobuf.Value`	`getInputs()` Required.
`com.google.protobuf.ValueOrBuilder`	`getInputsOrBuilder()` Required.
`String`	`getInputsSchemaUri()` Required.
`com.google.protobuf.ByteString`	`getInputsSchemaUriBytes()` Required.
`String`	`getInstructionUri()` Required.
`com.google.protobuf.ByteString`	`getInstructionUriBytes()` Required.
`int`	`getLabelerCount()` Required.
`int`	`getLabelingProgress()` Output only.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The labels with user-defined metadata to organize your DataLabelingJobs.
`Map<String,String>`	`getLabelsMap()` The labels with user-defined metadata to organize your DataLabelingJobs.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels with user-defined metadata to organize your DataLabelingJobs.
`String`	`getLabelsOrThrow(String key)` The labels with user-defined metadata to organize your DataLabelingJobs.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`com.google.protobuf.Parser<DataLabelingJob>`	`getParserForType()`
`int`	`getSerializedSize()`
`String`	`getSpecialistPools(int index)` The SpecialistPools' resource names associated with this job.
`com.google.protobuf.ByteString`	`getSpecialistPoolsBytes(int index)` The SpecialistPools' resource names associated with this job.
`int`	`getSpecialistPoolsCount()` The SpecialistPools' resource names associated with this job.
`com.google.protobuf.ProtocolStringList`	`getSpecialistPoolsList()` The SpecialistPools' resource names associated with this job.
`JobState`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasActiveLearningConfig()` Parameters that configure the active learning pipeline.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasCurrentSpend()` Output only.
`boolean`	`hasEncryptionSpec()` Customer-managed encryption key spec for a DataLabelingJob.
`boolean`	`hasError()` Output only.
`int`	`hashCode()`
`boolean`	`hasInputs()` Required.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static DataLabelingJob.Builder`	`newBuilder()`
`static DataLabelingJob.Builder`	`newBuilder(DataLabelingJob prototype)`
`DataLabelingJob.Builder`	`newBuilderForType()`
`protected DataLabelingJob.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static DataLabelingJob`	`parseDelimitedFrom(InputStream input)`
`static DataLabelingJob`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static DataLabelingJob`	`parseFrom(byte[] data)`
`static DataLabelingJob`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static DataLabelingJob`	`parseFrom(ByteBuffer data)`
`static DataLabelingJob`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static DataLabelingJob`	`parseFrom(com.google.protobuf.ByteString data)`
`static DataLabelingJob`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static DataLabelingJob`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static DataLabelingJob`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static DataLabelingJob`	`parseFrom(InputStream input)`
`static DataLabelingJob`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<DataLabelingJob>`	`parser()`
`DataLabelingJob.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DATASETS_FIELD_NUMBER
```
public static final int DATASETS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ANNOTATION_LABELS_FIELD_NUMBER
```
public static final int ANNOTATION_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELER_COUNT_FIELD_NUMBER
```
public static final int LABELER_COUNT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INSTRUCTION_URI_FIELD_NUMBER
```
public static final int INSTRUCTION_URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INPUTS_SCHEMA_URI_FIELD_NUMBER
```
public static final int INPUTS_SCHEMA_URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INPUTS_FIELD_NUMBER
```
public static final int INPUTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELING_PROGRESS_FIELD_NUMBER
```
public static final int LABELING_PROGRESS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CURRENT_SPEND_FIELD_NUMBER
```
public static final int CURRENT_SPEND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ERROR_FIELD_NUMBER
```
public static final int ERROR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SPECIALIST_POOLS_FIELD_NUMBER
```
public static final int SPECIALIST_POOLS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENCRYPTION_SPEC_FIELD_NUMBER
```
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ACTIVE_LEARNING_CONFIG_FIELD_NUMBER
```
public static final int ACTIVE_LEARNING_CONFIG_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()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 Output only. Resource name of the DataLabelingJob.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getName in interface DataLabelingJobOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Output only. Resource name of the DataLabelingJob.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNameBytes in interface DataLabelingJobOrBuilder

Returns:

The bytes for name.

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

Specified by:: getDisplayName in interface DataLabelingJobOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.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];

Specified by:: getDisplayNameBytes in interface DataLabelingJobOrBuilder
Returns:: The bytes for displayName.

getDatasetsList

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

Specified by:: getDatasetsList in interface DataLabelingJobOrBuilder
Returns:: A list containing the datasets.

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

getDatasetsCount in interface DataLabelingJobOrBuilder

Returns:

The count of datasets.

getDatasets
```
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) = { ... }
Specified by:

getDatasets in interface DataLabelingJobOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The datasets at the given index.

getDatasetsBytes
```
public com.google.protobuf.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) = { ... }
Specified by:

getDatasetsBytes in interface DataLabelingJobOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the datasets at the given index.