Interface HumanAnnotationConfigOrBuilder (0.175.0) 

public interface HumanAnnotationConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAnnotatedDatasetDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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];

Returns
Type Description
List<String>

A list containing the contributorEmails.

getInstruction()

public abstract String getInstruction()

Required. Instruction resource name.

string instruction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The instruction.

getInstructionBytes()

public abstract ByteString getInstructionBytes()

Required. Instruction resource name.

string instruction = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for instruction.

getLabelGroup()

public abstract 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 abstract 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 abstract 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 abstract 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.

getQuestionDuration()

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

Returns
Type Description
DurationOrBuilder

getReplicaCount()

public abstract 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.

getUserEmailAddress()

public abstract 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 abstract 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 abstract 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.