- 3.52.0 (latest)
- 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 static final class DataLabelingJob.Builder extends GeneratedMessageV3.Builder<DataLabelingJob.Builder> implements DataLabelingJobOrBuilderDataLabelingJob 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataLabelingJob.BuilderImplements
DataLabelingJobOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllDatasets(Iterable<String> values)
public DataLabelingJob.Builder addAllDatasets(Iterable<String> values) 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 |
values |
Iterable<String>The datasets to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
addAllSpecialistPools(Iterable<String> values)
public DataLabelingJob.Builder addAllSpecialistPools(Iterable<String> values)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The specialistPools to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
addDatasets(String value)
public DataLabelingJob.Builder addDatasets(String value) 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 |
value |
StringThe datasets to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
addDatasetsBytes(ByteString value)
public DataLabelingJob.Builder addDatasetsBytes(ByteString value) 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 |
value |
ByteStringThe bytes of the datasets to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DataLabelingJob.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
addSpecialistPools(String value)
public DataLabelingJob.Builder addSpecialistPools(String value)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe specialistPools to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
addSpecialistPoolsBytes(ByteString value)
public DataLabelingJob.Builder addSpecialistPoolsBytes(ByteString value)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the specialistPools to add. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
build()
public DataLabelingJob build()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob |
|
buildPartial()
public DataLabelingJob buildPartial()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob |
|
clear()
public DataLabelingJob.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearActiveLearningConfig()
public DataLabelingJob.Builder clearActiveLearningConfig()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 |
DataLabelingJob.Builder |
|
clearAnnotationLabels()
public DataLabelingJob.Builder clearAnnotationLabels()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearCreateTime()
public DataLabelingJob.Builder clearCreateTime()Output only. Timestamp when this DataLabelingJob was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearCurrentSpend()
public DataLabelingJob.Builder clearCurrentSpend()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 |
DataLabelingJob.Builder |
|
clearDatasets()
public DataLabelingJob.Builder clearDatasets() 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 |
DataLabelingJob.Builder |
This builder for chaining. |
clearDisplayName()
public DataLabelingJob.Builder clearDisplayName()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 |
DataLabelingJob.Builder |
This builder for chaining. |
clearEncryptionSpec()
public DataLabelingJob.Builder clearEncryptionSpec()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 |
DataLabelingJob.Builder |
|
clearError()
public DataLabelingJob.Builder clearError() 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 |
DataLabelingJob.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public DataLabelingJob.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearInputs()
public DataLabelingJob.Builder clearInputs()Required. Input config parameters for the DataLabelingJob.
.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearInputsSchemaUri()
public DataLabelingJob.Builder clearInputsSchemaUri()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 |
DataLabelingJob.Builder |
This builder for chaining. |
clearInstructionUri()
public DataLabelingJob.Builder clearInstructionUri()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 |
DataLabelingJob.Builder |
This builder for chaining. |
clearLabelerCount()
public DataLabelingJob.Builder clearLabelerCount()Required. Number of labelers to work on each DataItem.
int32 labeler_count = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
clearLabelingProgress()
public DataLabelingJob.Builder clearLabelingProgress()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 |
DataLabelingJob.Builder |
This builder for chaining. |
clearLabels()
public DataLabelingJob.Builder clearLabels()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearName()
public DataLabelingJob.Builder clearName()Output only. Resource name of the DataLabelingJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DataLabelingJob.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
clearSpecialistPools()
public DataLabelingJob.Builder clearSpecialistPools()The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
clearState()
public DataLabelingJob.Builder clearState()Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
clearUpdateTime()
public DataLabelingJob.Builder clearUpdateTime()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 |
DataLabelingJob.Builder |
|
clone()
public DataLabelingJob.Builder clone()| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
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 |
|
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. |
getActiveLearningConfigBuilder()
public ActiveLearningConfig.Builder getActiveLearningConfigBuilder()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.Builder |
|
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() (deprecated)
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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp when this DataLabelingJob was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
getCurrentSpendBuilder()
public Money.Builder getCurrentSpendBuilder()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.Builder |
|
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 |
intThe 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 |
intThe 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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getEncryptionSpecBuilder()
public EncryptionSpec.Builder getEncryptionSpecBuilder()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.Builder |
|
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. |
getErrorBuilder()
public Status.Builder getErrorBuilder() 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.Builder |
|
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. |
getInputsBuilder()
public Value.Builder getInputsBuilder()Required. Input config parameters for the DataLabelingJob.
.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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() (deprecated)
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 |
|
getMutableAnnotationLabels() (deprecated)
public Map<String,String> getMutableAnnotationLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMutableLabels() (deprecated)
public Map<String,String> getMutableLabels()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,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. |
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 |
intThe 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 |
intThe 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. |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeActiveLearningConfig(ActiveLearningConfig value)
public DataLabelingJob.Builder mergeActiveLearningConfig(ActiveLearningConfig value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ActiveLearningConfig |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeCreateTime(Timestamp value)
public DataLabelingJob.Builder mergeCreateTime(Timestamp value)Output only. Timestamp when this DataLabelingJob was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeCurrentSpend(Money value)
public DataLabelingJob.Builder mergeCurrentSpend(Money value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Money |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeEncryptionSpec(EncryptionSpec value)
public DataLabelingJob.Builder mergeEncryptionSpec(EncryptionSpec value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionSpec |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeError(Status value)
public DataLabelingJob.Builder mergeError(Status value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeFrom(DataLabelingJob other)
public DataLabelingJob.Builder mergeFrom(DataLabelingJob other)| Parameter | |
|---|---|
| Name | Description |
other |
DataLabelingJob |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataLabelingJob.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DataLabelingJob.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeInputs(Value value)
public DataLabelingJob.Builder mergeInputs(Value value)Required. Input config parameters for the DataLabelingJob.
.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Value |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DataLabelingJob.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
mergeUpdateTime(Timestamp value)
public DataLabelingJob.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp when this DataLabelingJob was updated most recently.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
putAllAnnotationLabels(Map<String,String> values)
public DataLabelingJob.Builder putAllAnnotationLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
putAllLabels(Map<String,String> values)
public DataLabelingJob.Builder putAllLabels(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
putAnnotationLabels(String key, String value)
public DataLabelingJob.Builder putAnnotationLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
putLabels(String key, String value)
public DataLabelingJob.Builder putLabels(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
removeAnnotationLabels(String key)
public DataLabelingJob.Builder removeAnnotationLabels(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 |
DataLabelingJob.Builder |
|
removeLabels(String key)
public DataLabelingJob.Builder removeLabels(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 |
DataLabelingJob.Builder |
|
setActiveLearningConfig(ActiveLearningConfig value)
public DataLabelingJob.Builder setActiveLearningConfig(ActiveLearningConfig value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ActiveLearningConfig |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setActiveLearningConfig(ActiveLearningConfig.Builder builderForValue)
public DataLabelingJob.Builder setActiveLearningConfig(ActiveLearningConfig.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ActiveLearningConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setCreateTime(Timestamp value)
public DataLabelingJob.Builder setCreateTime(Timestamp value)Output only. Timestamp when this DataLabelingJob was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public DataLabelingJob.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp when this DataLabelingJob was created.
.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setCurrentSpend(Money value)
public DataLabelingJob.Builder setCurrentSpend(Money value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Money |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setCurrentSpend(Money.Builder builderForValue)
public DataLabelingJob.Builder setCurrentSpend(Money.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.Money.Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setDatasets(int index, String value)
public DataLabelingJob.Builder setDatasets(int index, String value) 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 | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe datasets to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setDisplayName(String value)
public DataLabelingJob.Builder setDisplayName(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DataLabelingJob.Builder setDisplayNameBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setEncryptionSpec(EncryptionSpec value)
public DataLabelingJob.Builder setEncryptionSpec(EncryptionSpec value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
EncryptionSpec |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setEncryptionSpec(EncryptionSpec.Builder builderForValue)
public DataLabelingJob.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EncryptionSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setError(Status value)
public DataLabelingJob.Builder setError(Status value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setError(Status.Builder builderForValue)
public DataLabelingJob.Builder setError(Status.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public DataLabelingJob.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setInputs(Value value)
public DataLabelingJob.Builder setInputs(Value value)Required. Input config parameters for the DataLabelingJob.
.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
Value |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setInputs(Value.Builder builderForValue)
public DataLabelingJob.Builder setInputs(Value.Builder builderForValue)Required. Input config parameters for the DataLabelingJob.
.google.protobuf.Value inputs = 7 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setInputsSchemaUri(String value)
public DataLabelingJob.Builder setInputsSchemaUri(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe inputsSchemaUri to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setInputsSchemaUriBytes(ByteString value)
public DataLabelingJob.Builder setInputsSchemaUriBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for inputsSchemaUri to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setInstructionUri(String value)
public DataLabelingJob.Builder setInstructionUri(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe instructionUri to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setInstructionUriBytes(ByteString value)
public DataLabelingJob.Builder setInstructionUriBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for instructionUri to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setLabelerCount(int value)
public DataLabelingJob.Builder setLabelerCount(int value)Required. Number of labelers to work on each DataItem.
int32 labeler_count = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe labelerCount to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setLabelingProgress(int value)
public DataLabelingJob.Builder setLabelingProgress(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe labelingProgress to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setName(String value)
public DataLabelingJob.Builder setName(String value)Output only. Resource name of the DataLabelingJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DataLabelingJob.Builder setNameBytes(ByteString value)Output only. Resource name of the DataLabelingJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DataLabelingJob.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setSpecialistPools(int index, String value)
public DataLabelingJob.Builder setSpecialistPools(int index, String value)The SpecialistPools' resource names associated with this job.
repeated string specialist_pools = 16;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe specialistPools to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setState(JobState value)
public DataLabelingJob.Builder setState(JobState value)Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
JobStateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setStateValue(int value)
public DataLabelingJob.Builder setStateValue(int value)Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final DataLabelingJob.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setUpdateTime(Timestamp value)
public DataLabelingJob.Builder setUpdateTime(Timestamp value)Output only. Timestamp when this DataLabelingJob was updated most recently.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public DataLabelingJob.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp when this DataLabelingJob was updated most recently.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataLabelingJob.Builder |
|