Class ListEvaluationsRequest.Builder (0.45.0)

public static final class ListEvaluationsRequest.Builder extends GeneratedMessageV3.Builder<ListEvaluationsRequest.Builder> implements ListEvaluationsRequestOrBuilder

Request message for EvaluationService.ListEvaluations method.

Protobuf type google.cloud.discoveryengine.v1alpha.ListEvaluationsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListEvaluationsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

build()

public ListEvaluationsRequest build()
Returns
Type Description
ListEvaluationsRequest

buildPartial()

public ListEvaluationsRequest buildPartial()
Returns
Type Description
ListEvaluationsRequest

clear()

public ListEvaluationsRequest.Builder clear()
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListEvaluationsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListEvaluationsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

clearPageSize()

public ListEvaluationsRequest.Builder clearPageSize()

Maximum number of Evaluations 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
ListEvaluationsRequest.Builder

This builder for chaining.

clearPageToken()

public ListEvaluationsRequest.Builder clearPageToken()

A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clearParent()

public ListEvaluationsRequest.Builder clearParent()

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

clone()

public ListEvaluationsRequest.Builder clone()
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListEvaluationsRequest getDefaultInstanceForType()
Returns
Type Description
ListEvaluationsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

Maximum number of Evaluations 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 ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to EvaluationService.ListEvaluations 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 ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to EvaluationService.ListEvaluations 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.

getParent()

public String getParent()

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListEvaluationsRequest other)

public ListEvaluationsRequest.Builder mergeFrom(ListEvaluationsRequest other)
Parameter
Name Description
other ListEvaluationsRequest
Returns
Type Description
ListEvaluationsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListEvaluationsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListEvaluationsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListEvaluationsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListEvaluationsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

setPageSize(int value)

public ListEvaluationsRequest.Builder setPageSize(int value)

Maximum number of Evaluations 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;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListEvaluationsRequest.Builder setPageToken(String value)

A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListEvaluationsRequest.Builder setPageTokenBytes(ByteString value)

A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParent(String value)

public ListEvaluationsRequest.Builder setParent(String value)

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListEvaluationsRequest.Builder setParentBytes(ByteString value)

Required. The parent location resource name, such as projects/{project}/locations/{location}.

If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListEvaluationsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListEvaluationsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListEvaluationsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListEvaluationsRequest.Builder
Overrides