Class SearchExampleComparisonsRequest.Builder (0.171.0)

public static final class SearchExampleComparisonsRequest.Builder extends GeneratedMessageV3.Builder<SearchExampleComparisonsRequest.Builder> implements SearchExampleComparisonsRequestOrBuilder

Request message of SearchExampleComparisons.

Protobuf type google.cloud.datalabeling.v1beta1.SearchExampleComparisonsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchExampleComparisonsRequest build()
Returns
Type Description
SearchExampleComparisonsRequest

buildPartial()

public SearchExampleComparisonsRequest buildPartial()
Returns
Type Description
SearchExampleComparisonsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public SearchExampleComparisonsRequest.Builder clearPageSize()

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

clearPageToken()

public SearchExampleComparisonsRequest.Builder clearPageToken()

Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest.

If you don't specify this field, the API call requests the first page of the search.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

clearParent()

public SearchExampleComparisonsRequest.Builder clearParent()

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

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

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public SearchExampleComparisonsRequest getDefaultInstanceForType()
Returns
Type Description
SearchExampleComparisonsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest.

If you don't specify this field, the API call requests the first page of the search.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest.

If you don't specify this field, the API call requests the first page of the search.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

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(SearchExampleComparisonsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public SearchExampleComparisonsRequest.Builder setPageSize(int value)

Optional. Requested page size. Server may return fewer results than requested. Default value is 100.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchExampleComparisonsRequest.Builder setPageToken(String value)

Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest.

If you don't specify this field, the API call requests the first page of the search.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchExampleComparisonsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token identifying a page of results for the server to return. Typically obtained by the nextPageToken of the response to a previous search rquest.

If you don't specify this field, the API call requests the first page of the search.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

setParent(String value)

public SearchExampleComparisonsRequest.Builder setParent(String value)

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
SearchExampleComparisonsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public SearchExampleComparisonsRequest.Builder setParentBytes(ByteString value)

Required. Name of the Evaluation resource to search for example comparisons from. Format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id}</var>"

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
SearchExampleComparisonsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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