Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsRequest (v0.30.0)

0.30.0 (latest) 0.29.0 0.28.1 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsRequest.

Request message for EvaluationService.ListEvaluationResults method.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#evaluation

def evaluation() -> ::String

Returns

• (::String) — Required. The evaluation resource name, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

  If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a PERMISSION_DENIED error is returned.

#evaluation=

def evaluation=(value) -> ::String

Parameter

• value (::String) — Required. The evaluation resource name, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

  If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a PERMISSION_DENIED error is returned.

Returns

• (::String) — Required. The evaluation resource name, such as projects/{project}/locations/{location}/evaluations/{evaluation}.

  If the caller does not have permission to list ListEvaluationResultsResponse.EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a PERMISSION_DENIED error is returned.

#page_size

def page_size() -> ::Integer

Returns

• (::Integer) — Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
  1. Values above 1000 will be coerced to 1000.

  If this field is negative, an INVALID_ARGUMENT error is returned.

#page_size=

def page_size=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
  1. Values above 1000 will be coerced to 1000.

  If this field is negative, an INVALID_ARGUMENT error is returned.

Returns

• (::Integer) — Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
  1. Values above 1000 will be coerced to 1000.

  If this field is negative, an INVALID_ARGUMENT error is returned.

#page_token

def page_token() -> ::String

Returns

• (::String) — Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

#page_token=

def page_token=(value) -> ::String

Parameter

• value (::String) — Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

• (::String) — Optional. A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.