- 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 interface DataLabelingJobOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsAnnotationLabels(String key)
public abstract 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 abstract 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 |
|
getActiveLearningConfig()
public abstract 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 abstract 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() (deprecated)
public abstract Map<String,String> getAnnotationLabels()Use #getAnnotationLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getAnnotationLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The datasets at the given index. |
getDatasetsBytes(int index)
public abstract 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the datasets at the given index. |
getDatasetsCount()
public abstract 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 abstract 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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the datasets. |
getDisplayName()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
getSpecialistPools(int index)
public abstract String getSpecialistPools(int index)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The specialistPools at the given index. |
getSpecialistPoolsBytes(int index)
public abstract ByteString getSpecialistPoolsBytes(int index)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the specialistPools at the given index. |
getSpecialistPoolsCount()
public abstract 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 abstract List<String> getSpecialistPoolsList()The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the specialistPools. |
getState()
public abstract 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 abstract 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. |
getUpdateTime()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |