public static final class ListEvaluationResultsRequest.Builder extends GeneratedMessageV3.Builder<ListEvaluationResultsRequest.Builder> implements ListEvaluationResultsRequestOrBuilder
Request message for EvaluationService.ListEvaluationResults method.
Protobuf type google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListEvaluationResultsRequest.BuilderImplements
ListEvaluationResultsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListEvaluationResultsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
build()
public ListEvaluationResultsRequest build()
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest |
buildPartial()
public ListEvaluationResultsRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest |
clear()
public ListEvaluationResultsRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
clearEvaluation()
public ListEvaluationResultsRequest.Builder clearEvaluation()
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 |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ListEvaluationResultsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListEvaluationResultsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
clearPageSize()
public ListEvaluationResultsRequest.Builder clearPageSize()
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 |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListEvaluationResultsRequest.Builder clearPageToken()
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 |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
clone()
public ListEvaluationResultsRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
getDefaultInstanceForType()
public ListEvaluationResultsRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(ListEvaluationResultsRequest other)
public ListEvaluationResultsRequest.Builder mergeFrom(ListEvaluationResultsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListEvaluationResultsRequest |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListEvaluationResultsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListEvaluationResultsRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListEvaluationResultsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
setEvaluation(String value)
public ListEvaluationResultsRequest.Builder setEvaluation(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The evaluation to set. |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setEvaluationBytes(ByteString value)
public ListEvaluationResultsRequest.Builder setEvaluationBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for evaluation to set. |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ListEvaluationResultsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
setPageSize(int value)
public ListEvaluationResultsRequest.Builder setPageSize(int value)
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;
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListEvaluationResultsRequest.Builder setPageToken(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListEvaluationResultsRequest.Builder setPageTokenBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListEvaluationResultsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListEvaluationResultsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListEvaluationResultsRequest.Builder |