Package com.google.cloud.datalabeling.v1beta1

Interface HumanAnnotationConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HumanAnnotationConfig, HumanAnnotationConfig.Builder
    public interface HumanAnnotationConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getInstruction

        String getInstruction()
         Required. Instruction resource name.
        string instruction = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The instruction.

      • getInstructionBytes

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

      • getAnnotatedDatasetDisplayName

        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:
        The annotatedDatasetDisplayName.

      • getAnnotatedDatasetDisplayNameBytes

        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];
        Returns:
        The bytes for annotatedDatasetDisplayName.

      • getAnnotatedDatasetDescription

        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:
        The annotatedDatasetDescription.

      • getAnnotatedDatasetDescriptionBytes

        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];
        Returns:
        The bytes for annotatedDatasetDescription.

      • getLabelGroup

        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:
        The labelGroup.

      • getLabelGroupBytes

        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];
        Returns:
        The bytes for labelGroup.

      • getLanguageCode

        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];
        Returns:
        The languageCode.

      • getLanguageCodeBytes

        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];
        Returns:
        The bytes for languageCode.

      • getReplicaCount

        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:
        The replicaCount.

      • hasQuestionDuration

        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:
        Whether the questionDuration field is set.

      • getQuestionDuration

        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];
        Returns:
        The questionDuration.

      • getQuestionDurationOrBuilder

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

      • getContributorEmailsList

        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:
        A list containing the contributorEmails.

      • getContributorEmailsCount

        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:
        The count of contributorEmails.

      • getContributorEmails

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The contributorEmails at the given index.

      • getContributorEmailsBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the contributorEmails at the given index.

      • getUserEmailAddress

        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:
        The userEmailAddress.

      • getUserEmailAddressBytes

        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;
        Returns:
        The bytes for userEmailAddress.