com.google.cloud.aiplatform.v1

Interface DataLabelingJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataLabelingJob, DataLabelingJob.Builder

public interface DataLabelingJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
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.
List<String>	getDatasetsList() Required.
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.
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.
List<String>	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.
boolean	hasInputs() Required.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Resource name of the DataLabelingJob.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the DataLabelingJob.
 

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

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

Returns:

The bytes for displayName.

getDatasetsList

List<String> 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:

A list containing the datasets.

getDatasetsCount

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:

The count of datasets.

getDatasets

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

Parameters:

index - The index of the element to return.

Returns:

The datasets at the given index.

getDatasetsBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the datasets at the given index.

getAnnotationLabelsCount

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;

containsAnnotationLabels

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;

getAnnotationLabels

@Deprecated
Map<String,String> getAnnotationLabels()

Deprecated.

Use getAnnotationLabelsMap() instead.

getAnnotationLabelsMap

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;

getAnnotationLabelsOrDefault

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;

getAnnotationLabelsOrThrow

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;

getLabelerCount

int getLabelerCount()

 Required. Number of labelers to work on each DataItem.
 

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

Returns:

The labelerCount.

getInstructionUri

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:

The instructionUri.

getInstructionUriBytes

com.google.protobuf.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:

The bytes for instructionUri.

getInputsSchemaUri

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:

The inputsSchemaUri.

getInputsSchemaUriBytes

com.google.protobuf.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:

The bytes for inputsSchemaUri.

hasInputs

boolean hasInputs()

 Required. Input config parameters for the DataLabelingJob.
 

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

Returns:

Whether the inputs field is set.

getInputs

com.google.protobuf.Value getInputs()

 Required. Input config parameters for the DataLabelingJob.
 

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

Returns:

The inputs.

getInputsOrBuilder

com.google.protobuf.ValueOrBuilder getInputsOrBuilder()

 Required. Input config parameters for the DataLabelingJob.
 

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

getStateValue

int getStateValue()

 Output only. The detailed state of the job.
 

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

Returns:

The enum numeric value on the wire for state.

getState

JobState getState()

 Output only. The detailed state of the job.
 

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

Returns:

The state.

getLabelingProgress

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:

The labelingProgress.

hasCurrentSpend

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:

Whether the currentSpend field is set.

getCurrentSpend

com.google.type.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:

The currentSpend.

getCurrentSpendOrBuilder

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

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this DataLabelingJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this DataLabelingJob was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this DataLabelingJob was created.
 

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

hasError

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:

Whether the error field is set.

getError

com.google.rpc.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:

The error.

getErrorOrBuilder

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

getLabelsCount

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][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
   title.
 

map<string, string> labels = 11;

containsLabels

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][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
   title.
 

map<string, string> labels = 11;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
   title.
 

map<string, string> labels = 11;

getLabelsOrDefault

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][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
   title.
 

map<string, string> labels = 11;

getLabelsOrThrow

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][google.cloud.aiplatform.v1.DataLabelingJob.inputs_schema_uri]'s
   title.
 

map<string, string> labels = 11;

getSpecialistPoolsList

List<String> getSpecialistPoolsList()

 The SpecialistPools' resource names associated with this job.
 

repeated string specialist_pools = 16;

Returns:

A list containing the specialistPools.

getSpecialistPoolsCount

int getSpecialistPoolsCount()

 The SpecialistPools' resource names associated with this job.
 

repeated string specialist_pools = 16;

Returns:

The count of specialistPools.

getSpecialistPools

String getSpecialistPools(int index)

 The SpecialistPools' resource names associated with this job.
 

repeated string specialist_pools = 16;

Parameters:

index - The index of the element to return.

Returns:

The specialistPools at the given index.

getSpecialistPoolsBytes

com.google.protobuf.ByteString getSpecialistPoolsBytes(int index)

 The SpecialistPools' resource names associated with this job.
 

repeated string specialist_pools = 16;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the specialistPools at the given index.

hasEncryptionSpec

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:

Whether the encryptionSpec field is set.

getEncryptionSpec

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:

The encryptionSpec.

getEncryptionSpecOrBuilder

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;

hasActiveLearningConfig

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:

Whether the activeLearningConfig field is set.

getActiveLearningConfig

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:

The activeLearningConfig.

getActiveLearningConfigOrBuilder

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;