Package com.google.cloud.discoveryengine.v1beta

Class ListEvaluationResultsRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ListEvaluationResultsRequest.Builder>
com.google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest.Builder
All Implemented Interfaces:
ListEvaluationResultsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ListEvaluationResultsRequest
public static final class ListEvaluationResultsRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ListEvaluationResultsRequest.Builder> implements ListEvaluationResultsRequestOrBuilder
 Request message for
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 method.
Protobuf type google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest

  • Method Summary

    Modifier and Type
    Method
    Description
    ListEvaluationResultsRequest
    build()
     
    ListEvaluationResultsRequest
    buildPartial()
     
    ListEvaluationResultsRequest.Builder
    clear()
     
    ListEvaluationResultsRequest.Builder
    clearEvaluation()
    Required.
    ListEvaluationResultsRequest.Builder
    clearPageSize()
    Maximum number of [EvaluationResult][] to return.
    ListEvaluationResultsRequest.Builder
    clearPageToken()
    A page token [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], received from a previous [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] call.
    ListEvaluationResultsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getEvaluation()
    Required.
    com.google.protobuf.ByteString
    getEvaluationBytes()
    Required.
    int
    getPageSize()
    Maximum number of [EvaluationResult][] to return.
    String
    getPageToken()
    A page token [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], received from a previous [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] call.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    A page token [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], received from a previous [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] call.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ListEvaluationResultsRequest.Builder
    mergeFrom(ListEvaluationResultsRequest other)
     
    ListEvaluationResultsRequest.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ListEvaluationResultsRequest.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ListEvaluationResultsRequest.Builder
    setEvaluation(String value)
    Required.
    ListEvaluationResultsRequest.Builder
    setEvaluationBytes(com.google.protobuf.ByteString value)
    Required.
    ListEvaluationResultsRequest.Builder
    setPageSize(int value)
    Maximum number of [EvaluationResult][] to return.
    ListEvaluationResultsRequest.Builder
    setPageToken(String value)
    A page token [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], received from a previous [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] call.
    ListEvaluationResultsRequest.Builder
    setPageTokenBytes(com.google.protobuf.ByteString value)
    A page token [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token], received from a previous [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] call.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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.Builder<ListEvaluationResultsRequest.Builder>

    • clear

      public ListEvaluationResultsRequest.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.GeneratedMessage.Builder<ListEvaluationResultsRequest.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.GeneratedMessage.Builder<ListEvaluationResultsRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ListEvaluationResultsRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListEvaluationResultsRequest.Builder>

    • mergeFrom

      public ListEvaluationResultsRequest.Builder mergeFrom(ListEvaluationResultsRequest other)

    • isInitialized

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

    • mergeFrom

      public ListEvaluationResultsRequest.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<ListEvaluationResultsRequest.Builder>
      Throws:
      IOException

    • getEvaluation

      public String getEvaluation()
       Required. The evaluation resource name, such as
 `projects/{project}/locations/{location}/evaluations/{evaluation}`.

 If the caller does not have permission to list [EvaluationResult][]
 under this evaluation, regardless of whether or not this evaluation
 set exists, a `PERMISSION_DENIED` error is returned.
      string evaluation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEvaluation in interface ListEvaluationResultsRequestOrBuilder
      Returns:
      The evaluation.

    • getEvaluationBytes

      public com.google.protobuf.ByteString getEvaluationBytes()
       Required. The evaluation resource name, such as
 `projects/{project}/locations/{location}/evaluations/{evaluation}`.

 If the caller does not have permission to list [EvaluationResult][]
 under this evaluation, regardless of whether or not this evaluation
 set exists, a `PERMISSION_DENIED` error is returned.
      string evaluation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEvaluationBytes in interface ListEvaluationResultsRequestOrBuilder
      Returns:
      The bytes for evaluation.

    • setEvaluation

      public ListEvaluationResultsRequest.Builder setEvaluation(String value)
       Required. The evaluation resource name, such as
 `projects/{project}/locations/{location}/evaluations/{evaluation}`.

 If the caller does not have permission to list [EvaluationResult][]
 under this evaluation, regardless of whether or not this evaluation
 set exists, a `PERMISSION_DENIED` error is returned.
      string evaluation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The evaluation to set.
      Returns:
      This builder for chaining.

    • clearEvaluation

      public ListEvaluationResultsRequest.Builder clearEvaluation()
       Required. The evaluation resource name, such as
 `projects/{project}/locations/{location}/evaluations/{evaluation}`.

 If the caller does not have permission to list [EvaluationResult][]
 under this evaluation, regardless of whether or not this evaluation
 set exists, a `PERMISSION_DENIED` error is returned.
      string evaluation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setEvaluationBytes

      public ListEvaluationResultsRequest.Builder setEvaluationBytes(com.google.protobuf.ByteString value)
       Required. The evaluation resource name, such as
 `projects/{project}/locations/{location}/evaluations/{evaluation}`.

 If the caller does not have permission to list [EvaluationResult][]
 under this evaluation, regardless of whether or not this evaluation
 set exists, a `PERMISSION_DENIED` error is returned.
      string evaluation = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for evaluation to set.
      Returns:
      This builder for chaining.

    • getPageSize

      public int getPageSize()
       Maximum number of [EvaluationResult][] to return. If unspecified,
 defaults to 100. The maximum allowed value is 1000. Values above 1000 will
 be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
      int32 page_size = 2;
      Specified by:
      getPageSize in interface ListEvaluationResultsRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public ListEvaluationResultsRequest.Builder setPageSize(int value)
       Maximum number of [EvaluationResult][] to return. If unspecified,
 defaults to 100. The maximum allowed value is 1000. Values above 1000 will
 be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
      int32 page_size = 2;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public ListEvaluationResultsRequest.Builder clearPageSize()
       Maximum number of [EvaluationResult][] to return. If unspecified,
 defaults to 100. The maximum allowed value is 1000. Values above 1000 will
 be coerced to 1000.

 If this field is negative, an `INVALID_ARGUMENT` error is returned.
      int32 page_size = 2;
      Returns:
      This builder for chaining.

    • getPageToken

      public String getPageToken()
       A page token
 [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
 received from a previous
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Specified by:
      getPageToken in interface ListEvaluationResultsRequestOrBuilder
      Returns:
      The pageToken.

    • getPageTokenBytes

      public com.google.protobuf.ByteString getPageTokenBytes()
       A page token
 [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
 received from a previous
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Specified by:
      getPageTokenBytes in interface ListEvaluationResultsRequestOrBuilder
      Returns:
      The bytes for pageToken.

    • setPageToken

      public ListEvaluationResultsRequest.Builder setPageToken(String value)
       A page token
 [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
 received from a previous
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Parameters:
      value - The pageToken to set.
      Returns:
      This builder for chaining.

    • clearPageToken

      public ListEvaluationResultsRequest.Builder clearPageToken()
       A page token
 [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
 received from a previous
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Returns:
      This builder for chaining.

    • setPageTokenBytes

      public ListEvaluationResultsRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
       A page token
 [ListEvaluationResultsResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListEvaluationResultsResponse.next_page_token],
 received from a previous
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults]
 must match the call that provided the page token. Otherwise, an
 `INVALID_ARGUMENT` error is returned.
      string page_token = 3;
      Parameters:
      value - The bytes for pageToken to set.
      Returns:
      This builder for chaining.