Class ListExamplesRequest.Builder (0.171.0)

public static final class ListExamplesRequest.Builder extends GeneratedMessageV3.Builder<ListExamplesRequest.Builder> implements ListExamplesRequestOrBuilder

Request message for ListExamples.

Protobuf type google.cloud.datalabeling.v1beta1.ListExamplesRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListExamplesRequest build()
Returns
Type Description
ListExamplesRequest

buildPartial()

public ListExamplesRequest buildPartial()
Returns
Type Description
ListExamplesRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ListExamplesRequest.Builder clearFilter()

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListExamplesRequest.Builder clearPageSize()

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

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

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

clearPageToken()

public ListExamplesRequest.Builder clearPageToken()

Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

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

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

clearParent()

public ListExamplesRequest.Builder clearParent()

Required. Example resource parent.

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

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListExamplesRequest getDefaultInstanceForType()
Returns
Type Description
ListExamplesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

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

int32 page_size = 3 [(.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 ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

string page_token = 4 [(.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 ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

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

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. Example resource parent.

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. Example resource parent.

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ListExamplesRequest.Builder setFilter(String value)

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListExamplesRequest.Builder setFilterBytes(ByteString value)

Optional. An expression for filtering Examples. For annotated datasets that have annotation spec set, filter by annotation_spec.display_name is supported. Format "annotation_spec.display_name = {display_name}"

string filter = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListExamplesRequest.Builder setPageSize(int value)

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

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

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListExamplesRequest.Builder setPageToken(String value)

Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListExamplesRequest.Builder setPageTokenBytes(ByteString value)

Optional. A token identifying a page of results for the server to return. Typically obtained by ListExamplesResponse.next_page_token of the previous [DataLabelingService.ListExamples] call. Return first page if empty.

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setParent(String value)

public ListExamplesRequest.Builder setParent(String value)

Required. Example resource parent.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListExamplesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListExamplesRequest.Builder setParentBytes(ByteString value)

Required. Example resource parent.

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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