public static final class ListEvaluationResultsRequest.Builder extends GeneratedMessage.Builder<ListEvaluationResultsRequest.Builder> implements ListEvaluationResultsRequestOrBuilderRequest message for EvaluationService.ListEvaluationResults method.
Protobuf type google.cloud.discoveryengine.v1beta.ListEvaluationResultsRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ListEvaluationResultsRequest.BuilderImplements
ListEvaluationResultsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
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
ListEvaluationResultsResponse.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. |
clearPageSize()
public ListEvaluationResultsRequest.Builder clearPageSize()Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
Values above 1000 will be coerced to 1000.
If this field is negative, an
INVALID_ARGUMENTerror is returned.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListEvaluationResultsRequest.Builder clearPageToken()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.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
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
ListEvaluationResultsResponse.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
ListEvaluationResultsResponse.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()Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
Values above 1000 will be coerced to 1000.
If this field is negative, an
INVALID_ARGUMENTerror is returned.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public String getPageToken()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.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()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.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
internalGetFieldAccessorTable()
protected GeneratedMessage.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 |
|
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
ListEvaluationResultsResponse.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 |
StringThe 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
ListEvaluationResultsResponse.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 |
ByteStringThe bytes for evaluation to set. |
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListEvaluationResultsRequest.Builder setPageSize(int value)Optional. Maximum number of ListEvaluationResultsResponse.EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is
Values above 1000 will be coerced to 1000.
If this field is negative, an
INVALID_ARGUMENTerror is returned.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListEvaluationResultsRequest.Builder setPageToken(String value)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.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListEvaluationResultsRequest.Builder setPageTokenBytes(ByteString value)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.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListEvaluationResultsRequest.Builder |
This builder for chaining. |