Discovery Engine v1beta API - Class ListEvaluationResultsRequest (1.0.0-beta18)

Version latest

• 1.0.0-beta18 (latest)
• 1.0.0-beta17

public sealed class ListEvaluationResultsRequest : IMessage<ListEvaluationResultsRequest>, IEquatable<ListEvaluationResultsRequest>, IDeepCloneable<ListEvaluationResultsRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1beta API class ListEvaluationResultsRequest.

Request message for [EvaluationService.ListEvaluationResults][google.cloud.discoveryengine.v1beta.EvaluationService.ListEvaluationResults] method.

Inheritance

object > ListEvaluationResultsRequest

Implements

IMessageListEvaluationResultsRequest, IEquatableListEvaluationResultsRequest, IDeepCloneableListEvaluationResultsRequest, IBufferMessage, IMessage, IPageRequest

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

ListEvaluationResultsRequest()

public ListEvaluationResultsRequest()

ListEvaluationResultsRequest(ListEvaluationResultsRequest)

public ListEvaluationResultsRequest(ListEvaluationResultsRequest other)

Parameter
Name	Description
other	ListEvaluationResultsRequest

Properties

Evaluation

public string Evaluation { get; set; }

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.

Property Value
Type	Description
string

EvaluationAsEvaluationName

public EvaluationName EvaluationAsEvaluationName { get; set; }

EvaluationName-typed view over the Evaluation resource name property.

Property Value
Type	Description
EvaluationName

PageSize

public int PageSize { get; set; }

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.

Property Value
Type	Description
int

PageToken

public string PageToken { get; set; }

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.

Property Value
Type	Description
string