Class ListEvaluationResultsRequest (0.43.0)

public final class ListEvaluationResultsRequest extends GeneratedMessageV3 implements ListEvaluationResultsRequestOrBuilder

Request message for EvaluationService.ListEvaluationResults method.

Protobuf type google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest

Static Fields

EVALUATION_FIELD_NUMBER

public static final int EVALUATION_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListEvaluationResultsRequest getDefaultInstance()
Returns
Type Description
ListEvaluationResultsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ListEvaluationResultsRequest.Builder newBuilder()
Returns
Type Description
ListEvaluationResultsRequest.Builder

newBuilder(ListEvaluationResultsRequest prototype)

public static ListEvaluationResultsRequest.Builder newBuilder(ListEvaluationResultsRequest prototype)
Parameter
Name Description
prototype ListEvaluationResultsRequest
Returns
Type Description
ListEvaluationResultsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListEvaluationResultsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListEvaluationResultsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListEvaluationResultsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListEvaluationResultsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListEvaluationResultsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListEvaluationResultsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListEvaluationResultsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationResultsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListEvaluationResultsRequest> parser()
Returns
Type Description
Parser<ListEvaluationResultsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListEvaluationResultsRequest getDefaultInstanceForType()
Returns
Type Description
ListEvaluationResultsRequest

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) = { ... }

Returns
Type Description
String

The evaluation.

getEvaluationBytes()

public 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
Type Description
ByteString

The bytes for evaluation.

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;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParserForType()

public Parser<ListEvaluationResultsRequest> getParserForType()
Returns
Type Description
Parser<ListEvaluationResultsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListEvaluationResultsRequest.Builder newBuilderForType()
Returns
Type Description
ListEvaluationResultsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListEvaluationResultsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListEvaluationResultsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListEvaluationResultsRequest.Builder toBuilder()
Returns
Type Description
ListEvaluationResultsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException