Package com.google.cloud.datalabeling.v1beta1

Class HumanAnnotationConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class HumanAnnotationConfig extends com.google.protobuf.GeneratedMessage implements HumanAnnotationConfigOrBuilder
 Configuration for how human labeling task should be done.
Protobuf type google.cloud.datalabeling.v1beta1.HumanAnnotationConfig
See Also:

  • Field Details

    • INSTRUCTION_FIELD_NUMBER

      public static final int INSTRUCTION_FIELD_NUMBER
      See Also:

    • ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER

      public static final int ANNOTATED_DATASET_DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER

      public static final int ANNOTATED_DATASET_DESCRIPTION_FIELD_NUMBER
      See Also:

    • LABEL_GROUP_FIELD_NUMBER

      public static final int LABEL_GROUP_FIELD_NUMBER
      See Also:

    • LANGUAGE_CODE_FIELD_NUMBER

      public static final int LANGUAGE_CODE_FIELD_NUMBER
      See Also:

    • REPLICA_COUNT_FIELD_NUMBER

      public static final int REPLICA_COUNT_FIELD_NUMBER
      See Also:

    • QUESTION_DURATION_FIELD_NUMBER

      public static final int QUESTION_DURATION_FIELD_NUMBER
      See Also:

    • CONTRIBUTOR_EMAILS_FIELD_NUMBER

      public static final int CONTRIBUTOR_EMAILS_FIELD_NUMBER
      See Also:

    • USER_EMAIL_ADDRESS_FIELD_NUMBER

      public static final int USER_EMAIL_ADDRESS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getInstruction

      public String getInstruction()
       Required. Instruction resource name.
      string instruction = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInstruction in interface HumanAnnotationConfigOrBuilder
      Returns:
      The instruction.

    • getInstructionBytes

      public com.google.protobuf.ByteString getInstructionBytes()
       Required. Instruction resource name.
      string instruction = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getInstructionBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for instruction.

    • 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];
      Specified by:
      getAnnotatedDatasetDisplayName in interface HumanAnnotationConfigOrBuilder
      Returns:
      The annotatedDatasetDisplayName.

    • 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 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getAnnotatedDatasetDisplayNameBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for annotatedDatasetDisplayName.

    • 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];
      Specified by:
      getAnnotatedDatasetDescription in interface HumanAnnotationConfigOrBuilder
      Returns:
      The annotatedDatasetDescription.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnnotatedDatasetDescriptionBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for annotatedDatasetDescription.

    • 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];
      Specified by:
      getLabelGroup in interface HumanAnnotationConfigOrBuilder
      Returns:
      The labelGroup.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelGroupBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for labelGroup.

    • 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.
      string language_code = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCode in interface HumanAnnotationConfigOrBuilder
      Returns:
      The languageCode.

    • 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.
      string language_code = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLanguageCodeBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for languageCode.

    • 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];
      Specified by:
      getReplicaCount in interface HumanAnnotationConfigOrBuilder
      Returns:
      The replicaCount.

    • 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];
      Specified by:
      hasQuestionDuration in interface HumanAnnotationConfigOrBuilder
      Returns:
      Whether the questionDuration field is set.

    • getQuestionDuration

      public com.google.protobuf.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];
      Specified by:
      getQuestionDuration in interface HumanAnnotationConfigOrBuilder
      Returns:
      The questionDuration.

    • getQuestionDurationOrBuilder

      public com.google.protobuf.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];
      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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContributorEmailsList in interface HumanAnnotationConfigOrBuilder
      Returns:
      A list containing the contributorEmails.

    • 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];
      Specified by:
      getContributorEmailsCount in interface HumanAnnotationConfigOrBuilder
      Returns:
      The count of contributorEmails.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContributorEmails in interface HumanAnnotationConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The contributorEmails at the given index.

    • 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 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getContributorEmailsBytes in interface HumanAnnotationConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the contributorEmails at the given index.

    • 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;
      Specified by:
      getUserEmailAddress in interface HumanAnnotationConfigOrBuilder
      Returns:
      The userEmailAddress.

    • getUserEmailAddressBytes

      public com.google.protobuf.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;
      Specified by:
      getUserEmailAddressBytes in interface HumanAnnotationConfigOrBuilder
      Returns:
      The bytes for userEmailAddress.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public HumanAnnotationConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder