Package com.google.cloud.discoveryengine.v1beta

Interface ListEvaluationResultsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListEvaluationResultsRequest, ListEvaluationResultsRequest.Builder
@Generated public interface ListEvaluationResultsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getEvaluation

      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) = { ... }
      Returns:
      The evaluation.

    • getEvaluationBytes

      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) = { ... }
      Returns:
      The bytes for evaluation.

    • getPageSize

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

    • getPageToken

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

    • getPageTokenBytes

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