Class ListEvaluationsRequest.Builder

  • All Implemented Interfaces:
    ListEvaluationsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    ListEvaluationsRequest

    public static final class ListEvaluationsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
    implements ListEvaluationsRequestOrBuilder
     Retrieves a list of evaluations for a given
     [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion].
     
    Protobuf type google.cloud.documentai.v1beta3.ListEvaluationsRequest
    • Method Detail

      • 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.Builder<ListEvaluationsRequest.Builder>
      • clear

        public ListEvaluationsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • getDefaultInstanceForType

        public ListEvaluationsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

        public ListEvaluationsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public ListEvaluationsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public ListEvaluationsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • clearField

        public ListEvaluationsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • clearOneof

        public ListEvaluationsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • setRepeatedField

        public ListEvaluationsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               int index,
                                                               Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • addRepeatedField

        public ListEvaluationsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                               Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • mergeFrom

        public ListEvaluationsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEvaluationsRequest.Builder>
        Throws:
        IOException
      • getParent

        public String getParent()
         Required. The resource name of the
         [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
         list evaluations for.
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParent in interface ListEvaluationsRequestOrBuilder
        Returns:
        The parent.
      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Required. The resource name of the
         [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
         list evaluations for.
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getParentBytes in interface ListEvaluationsRequestOrBuilder
        Returns:
        The bytes for parent.
      • setParent

        public ListEvaluationsRequest.Builder setParent​(String value)
         Required. The resource name of the
         [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
         list evaluations for.
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.
      • clearParent

        public ListEvaluationsRequest.Builder clearParent()
         Required. The resource name of the
         [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
         list evaluations for.
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setParentBytes

        public ListEvaluationsRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the
         [ProcessorVersion][google.cloud.documentai.v1beta3.ProcessorVersion] to
         list evaluations for.
         `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}`
         
        string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.
      • getPageSize

        public int getPageSize()
         The standard list page size.
         If unspecified, at most `5` evaluations are returned.
         The maximum value is `100`. Values above `100` are coerced to `100`.
         
        int32 page_size = 2;
        Specified by:
        getPageSize in interface ListEvaluationsRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

        public ListEvaluationsRequest.Builder setPageSize​(int value)
         The standard list page size.
         If unspecified, at most `5` evaluations are returned.
         The maximum value is `100`. Values above `100` are coerced to `100`.
         
        int32 page_size = 2;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public ListEvaluationsRequest.Builder clearPageSize()
         The standard list page size.
         If unspecified, at most `5` evaluations are returned.
         The maximum value is `100`. Values above `100` are coerced to `100`.
         
        int32 page_size = 2;
        Returns:
        This builder for chaining.
      • getPageToken

        public String getPageToken()
         A page token, received from a previous `ListEvaluations` call.
         Provide this to retrieve the subsequent page.
         
        string page_token = 3;
        Specified by:
        getPageToken in interface ListEvaluationsRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token, received from a previous `ListEvaluations` call.
         Provide this to retrieve the subsequent page.
         
        string page_token = 3;
        Specified by:
        getPageTokenBytes in interface ListEvaluationsRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public ListEvaluationsRequest.Builder setPageToken​(String value)
         A page token, received from a previous `ListEvaluations` call.
         Provide this to retrieve the subsequent page.
         
        string page_token = 3;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public ListEvaluationsRequest.Builder clearPageToken()
         A page token, received from a previous `ListEvaluations` call.
         Provide this to retrieve the subsequent page.
         
        string page_token = 3;
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public ListEvaluationsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         A page token, received from a previous `ListEvaluations` call.
         Provide this to retrieve the subsequent page.
         
        string page_token = 3;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final ListEvaluationsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>
      • mergeUnknownFields

        public final ListEvaluationsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder>