public final class HumanAnnotationConfig extends GeneratedMessageV3 implements HumanAnnotationConfigOrBuilder
Configuration for how human labeling task should be done.
Protobuf type google.cloud.datalabeling.v1beta1.HumanAnnotationConfig
Static Fields
ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER
public static final int ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER
public static final int ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONTRIBUTOR_EMAILS_FIELD_NUMBER
public static final int CONTRIBUTOR_EMAILS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INSTRUCTION_FIELD_NUMBER
public static final int INSTRUCTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABEL_GROUP_FIELD_NUMBER
public static final int LABEL_GROUP_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LANGUAGE_CODE_FIELD_NUMBER
public static final int LANGUAGE_CODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
QUESTION_DURATION_FIELD_NUMBER
public static final int QUESTION_DURATION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
REPLICA_COUNT_FIELD_NUMBER
public static final int REPLICA_COUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
USER_EMAIL_ADDRESS_FIELD_NUMBER
public static final int USER_EMAIL_ADDRESS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static HumanAnnotationConfig getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static HumanAnnotationConfig.Builder newBuilder()
newBuilder(HumanAnnotationConfig prototype)
public static HumanAnnotationConfig.Builder newBuilder(HumanAnnotationConfig prototype)
public static HumanAnnotationConfig parseDelimitedFrom(InputStream input)
public static HumanAnnotationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static HumanAnnotationConfig parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static HumanAnnotationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static HumanAnnotationConfig parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HumanAnnotationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static HumanAnnotationConfig parseFrom(CodedInputStream input)
public static HumanAnnotationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static HumanAnnotationConfig parseFrom(InputStream input)
public static HumanAnnotationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static HumanAnnotationConfig parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static HumanAnnotationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<HumanAnnotationConfig> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAnnotatedDatasetDescription()
public String getAnnotatedDatasetDescription()
Optional. A human-readable description for AnnotatedDataset.
The description can be up to 10000 characters long.
string annotated_dataset_description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The annotatedDatasetDescription.
|
getAnnotatedDatasetDescriptionBytes()
public ByteString getAnnotatedDatasetDescriptionBytes()
Optional. A human-readable description for AnnotatedDataset.
The description can be up to 10000 characters long.
string annotated_dataset_description = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for annotatedDatasetDescription.
|
getAnnotatedDatasetDisplayName()
public String getAnnotatedDatasetDisplayName()
Required. A human-readable name for AnnotatedDataset defined by
users. Maximum of 64 characters
.
string annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The annotatedDatasetDisplayName.
|
getAnnotatedDatasetDisplayNameBytes()
public ByteString getAnnotatedDatasetDisplayNameBytes()
Required. A human-readable name for AnnotatedDataset defined by
users. Maximum of 64 characters
.
string annotated_dataset_display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for annotatedDatasetDisplayName.
|
getContributorEmails(int index)
public String getContributorEmails(int index)
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:
https://crowd-compute.appspot.com/
repeated string contributor_emails = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The contributorEmails at the given index.
|
getContributorEmailsBytes(int index)
public ByteString getContributorEmailsBytes(int index)
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:
https://crowd-compute.appspot.com/
repeated string contributor_emails = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the contributorEmails at the given index.
|
getContributorEmailsCount()
public int getContributorEmailsCount()
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:
https://crowd-compute.appspot.com/
repeated string contributor_emails = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The count of contributorEmails.
|
getContributorEmailsList()
public ProtocolStringList getContributorEmailsList()
Optional. If you want your own labeling contributors to manage and work on
this labeling request, you can set these contributors here. We will give
them access to the question types in crowdcompute. Note that these
emails must be registered in crowdcompute worker UI:
https://crowd-compute.appspot.com/
repeated string contributor_emails = 9 [(.google.api.field_behavior) = OPTIONAL];
getDefaultInstanceForType()
public HumanAnnotationConfig getDefaultInstanceForType()
getInstruction()
public String getInstruction()
Required. Instruction resource name.
string instruction = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
String | The instruction.
|
getInstructionBytes()
public ByteString getInstructionBytes()
Required. Instruction resource name.
string instruction = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for instruction.
|
getLabelGroup()
public String getLabelGroup()
Optional. A human-readable label used to logically group labeling tasks.
This string must match the regular expression [a-zA-Z\\d_-]{0,128}.
string label_group = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The labelGroup.
|
getLabelGroupBytes()
public ByteString getLabelGroupBytes()
Optional. A human-readable label used to logically group labeling tasks.
This string must match the regular expression [a-zA-Z\\d_-]{0,128}.
string label_group = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for labelGroup.
|
getLanguageCode()
public String getLanguageCode()
Optional. The Language of this question, as a
BCP-47.
Default value is en-US.
Only need to set this when task is language related. For example, French
text classification.
string language_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The languageCode.
|
getLanguageCodeBytes()
public ByteString getLanguageCodeBytes()
Optional. The Language of this question, as a
BCP-47.
Default value is en-US.
Only need to set this when task is language related. For example, French
text classification.
string language_code = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for languageCode.
|
getParserForType()
public Parser<HumanAnnotationConfig> getParserForType()
Overrides
getQuestionDuration()
public Duration getQuestionDuration()
Optional. Maximum duration for contributors to answer a question. Maximum
is 3600 seconds. Default is 3600 seconds.
.google.protobuf.Duration question_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Duration | The questionDuration.
|
getQuestionDurationOrBuilder()
public DurationOrBuilder getQuestionDurationOrBuilder()
Optional. Maximum duration for contributors to answer a question. Maximum
is 3600 seconds. Default is 3600 seconds.
.google.protobuf.Duration question_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
getReplicaCount()
public int getReplicaCount()
Optional. Replication of questions. Each question will be sent to up to
this number of contributors to label. Aggregated answers will be returned.
Default is set to 1.
For image related labeling, valid values are 1, 3, 5.
int32 replica_count = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The replicaCount.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
getUserEmailAddress()
public String getUserEmailAddress()
Email of the user who started the labeling task and should be notified by
email. If empty no notification will be sent.
string user_email_address = 10;
| Returns |
|---|
| Type | Description |
String | The userEmailAddress.
|
getUserEmailAddressBytes()
public ByteString getUserEmailAddressBytes()
Email of the user who started the labeling task and should be notified by
email. If empty no notification will be sent.
string user_email_address = 10;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for userEmailAddress.
|
hasQuestionDuration()
public boolean hasQuestionDuration()
Optional. Maximum duration for contributors to answer a question. Maximum
is 3600 seconds. Default is 3600 seconds.
.google.protobuf.Duration question_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the questionDuration field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public HumanAnnotationConfig.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected HumanAnnotationConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public HumanAnnotationConfig.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
