com.google.cloud.datalabeling.v1beta1

Class HumanAnnotationConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datalabeling.v1beta1.HumanAnnotationConfig

All Implemented Interfaces:

HumanAnnotationConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class HumanAnnotationConfig
extends com.google.protobuf.GeneratedMessageV3
implements HumanAnnotationConfigOrBuilder

 Configuration for how human labeling task should be done.
 

Protobuf type google.cloud.datalabeling.v1beta1.HumanAnnotationConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HumanAnnotationConfig.Builder Configuration for how human labeling task should be done.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER
static int	ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER
static int	CONTRIBUTOR_EMAILS_FIELD_NUMBER
static int	INSTRUCTION_FIELD_NUMBER
static int	LABEL_GROUP_FIELD_NUMBER
static int	LANGUAGE_CODE_FIELD_NUMBER
static int	QUESTION_DURATION_FIELD_NUMBER
static int	REPLICA_COUNT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAnnotatedDatasetDescription() Optional.
com.google.protobuf.ByteString	getAnnotatedDatasetDescriptionBytes() Optional.
String	getAnnotatedDatasetDisplayName() Required.
com.google.protobuf.ByteString	getAnnotatedDatasetDisplayNameBytes() Required.
String	getContributorEmails(int index) Optional.
com.google.protobuf.ByteString	getContributorEmailsBytes(int index) Optional.
int	getContributorEmailsCount() Optional.
com.google.protobuf.ProtocolStringList	getContributorEmailsList() Optional.
static HumanAnnotationConfig	getDefaultInstance()
HumanAnnotationConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getInstruction() Required except for LabelAudio case.
com.google.protobuf.ByteString	getInstructionBytes() Required except for LabelAudio case.
String	getLabelGroup() Optional.
com.google.protobuf.ByteString	getLabelGroupBytes() Optional.
String	getLanguageCode() Optional.
com.google.protobuf.ByteString	getLanguageCodeBytes() Optional.
com.google.protobuf.Parser<HumanAnnotationConfig>	getParserForType()
com.google.protobuf.Duration	getQuestionDuration() Optional.
com.google.protobuf.DurationOrBuilder	getQuestionDurationOrBuilder() Optional.
int	getReplicaCount() Optional.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasQuestionDuration() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static HumanAnnotationConfig.Builder	newBuilder()
static HumanAnnotationConfig.Builder	newBuilder(HumanAnnotationConfig prototype)
HumanAnnotationConfig.Builder	newBuilderForType()
protected HumanAnnotationConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static HumanAnnotationConfig	parseDelimitedFrom(InputStream input)
static HumanAnnotationConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HumanAnnotationConfig	parseFrom(byte[] data)
static HumanAnnotationConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HumanAnnotationConfig	parseFrom(ByteBuffer data)
static HumanAnnotationConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HumanAnnotationConfig	parseFrom(com.google.protobuf.ByteString data)
static HumanAnnotationConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HumanAnnotationConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static HumanAnnotationConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static HumanAnnotationConfig	parseFrom(InputStream input)
static HumanAnnotationConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<HumanAnnotationConfig>	parser()
HumanAnnotationConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INSTRUCTION_FIELD_NUMBER

public static final int INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER

public static final int ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER

public static final int ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

LABEL_GROUP_FIELD_NUMBER

public static final int LABEL_GROUP_FIELD_NUMBER

See Also:

Constant Field Values

LANGUAGE_CODE_FIELD_NUMBER

public static final int LANGUAGE_CODE_FIELD_NUMBER

See Also:

Constant Field Values

REPLICA_COUNT_FIELD_NUMBER

public static final int REPLICA_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

QUESTION_DURATION_FIELD_NUMBER

public static final int QUESTION_DURATION_FIELD_NUMBER

See Also:

Constant Field Values

CONTRIBUTOR_EMAILS_FIELD_NUMBER

public static final int CONTRIBUTOR_EMAILS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getInstruction

public String getInstruction()

 Required except for LabelAudio case. Instruction resource name.
 

string instruction = 1;

Specified by:

getInstruction in interface HumanAnnotationConfigOrBuilder

getInstructionBytes

public com.google.protobuf.ByteString getInstructionBytes()

 Required except for LabelAudio case. Instruction resource name.
 

string instruction = 1;

Specified by:

getInstructionBytes in interface HumanAnnotationConfigOrBuilder

getAnnotatedDatasetDisplayName

public String getAnnotatedDatasetDisplayName()

 Required. A human-readable name for AnnotatedDataset defined by
 users. Maximum of 64 characters
 .
 

string annotated_dataset_display_name = 2;

Specified by:

getAnnotatedDatasetDisplayName in interface HumanAnnotationConfigOrBuilder

getAnnotatedDatasetDisplayNameBytes

public com.google.protobuf.ByteString getAnnotatedDatasetDisplayNameBytes()

 Required. A human-readable name for AnnotatedDataset defined by
 users. Maximum of 64 characters
 .
 

string annotated_dataset_display_name = 2;

Specified by:

getAnnotatedDatasetDisplayNameBytes in interface HumanAnnotationConfigOrBuilder

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;

Specified by:

getAnnotatedDatasetDescription in interface HumanAnnotationConfigOrBuilder

getAnnotatedDatasetDescriptionBytes

public com.google.protobuf.ByteString getAnnotatedDatasetDescriptionBytes()

 Optional. A human-readable description for AnnotatedDataset.
 The description can be up to 10000 characters long.
 

string annotated_dataset_description = 3;

Specified by:

getAnnotatedDatasetDescriptionBytes in interface HumanAnnotationConfigOrBuilder

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;

Specified by:

getLabelGroup in interface HumanAnnotationConfigOrBuilder

getLabelGroupBytes

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

Specified by:

getLabelGroupBytes in interface HumanAnnotationConfigOrBuilder

getLanguageCode

public String getLanguageCode()

 Optional. The Language of this question, as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Default value is en-US.
 Only need to set this when task is language related. For example, French
 text classification or Chinese audio transcription.
 

string language_code = 5;

Specified by:

getLanguageCode in interface HumanAnnotationConfigOrBuilder

getLanguageCodeBytes

public com.google.protobuf.ByteString getLanguageCodeBytes()

 Optional. The Language of this question, as a
 [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 Default value is en-US.
 Only need to set this when task is language related. For example, French
 text classification or Chinese audio transcription.
 

string language_code = 5;

Specified by:

getLanguageCodeBytes in interface HumanAnnotationConfigOrBuilder

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;

Specified by:

getReplicaCount in interface HumanAnnotationConfigOrBuilder

hasQuestionDuration

public boolean hasQuestionDuration()

 Optional. Maximum duration for contributors to answer a question. Default
 is 1800 seconds.
 

.google.protobuf.Duration question_duration = 7;

Specified by:

hasQuestionDuration in interface HumanAnnotationConfigOrBuilder

getQuestionDuration

public com.google.protobuf.Duration getQuestionDuration()

 Optional. Maximum duration for contributors to answer a question. Default
 is 1800 seconds.
 

.google.protobuf.Duration question_duration = 7;

Specified by:

getQuestionDuration in interface HumanAnnotationConfigOrBuilder

getQuestionDurationOrBuilder

public com.google.protobuf.DurationOrBuilder getQuestionDurationOrBuilder()

 Optional. Maximum duration for contributors to answer a question. Default
 is 1800 seconds.
 

.google.protobuf.Duration question_duration = 7;

Specified by:

getQuestionDurationOrBuilder in interface HumanAnnotationConfigOrBuilder

getContributorEmailsList

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

Specified by:

getContributorEmailsList in interface HumanAnnotationConfigOrBuilder

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;

Specified by:

getContributorEmailsCount in interface HumanAnnotationConfigOrBuilder

getContributorEmails

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;

Specified by:

getContributorEmails in interface HumanAnnotationConfigOrBuilder

getContributorEmailsBytes

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

Specified by:

getContributorEmailsBytes in interface HumanAnnotationConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static HumanAnnotationConfig parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static HumanAnnotationConfig parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static HumanAnnotationConfig parseFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static HumanAnnotationConfig parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static HumanAnnotationConfig parseDelimitedFrom(InputStream input,
                                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                throws IOException

Throws:

IOException

parseFrom

public static HumanAnnotationConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

public static HumanAnnotationConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

newBuilderForType

public HumanAnnotationConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static HumanAnnotationConfig.Builder newBuilder()

newBuilder

public static HumanAnnotationConfig.Builder newBuilder(HumanAnnotationConfig prototype)

toBuilder

public HumanAnnotationConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected HumanAnnotationConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static HumanAnnotationConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<HumanAnnotationConfig> parser()

getParserForType

public com.google.protobuf.Parser<HumanAnnotationConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public HumanAnnotationConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder