Class ViewCollectionItemsRequest.Builder (0.2.0)

public static final class ViewCollectionItemsRequest.Builder extends GeneratedMessageV3.Builder<ViewCollectionItemsRequest.Builder> implements ViewCollectionItemsRequestOrBuilder

Request message for ViewCollectionItems.

Protobuf type google.cloud.visionai.v1.ViewCollectionItemsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ViewCollectionItemsRequest build()
Returns
Type Description
ViewCollectionItemsRequest

buildPartial()

public ViewCollectionItemsRequest buildPartial()
Returns
Type Description
ViewCollectionItemsRequest

clear()

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

clearCollection()

public ViewCollectionItemsRequest.Builder clearCollection()

Required. The collection to view. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

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

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ViewCollectionItemsRequest.Builder clearPageSize()

The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

clearPageToken()

public ViewCollectionItemsRequest.Builder clearPageToken()

A page token, received from a previous ViewCollectionItemsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ViewCollectionItemsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

clone()

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

getCollection()

public String getCollection()

Required. The collection to view. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

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

Returns
Type Description
String

The collection.

getCollectionBytes()

public ByteString getCollectionBytes()

Required. The collection to view. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

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

Returns
Type Description
ByteString

The bytes for collection.

getDefaultInstanceForType()

public ViewCollectionItemsRequest getDefaultInstanceForType()
Returns
Type Description
ViewCollectionItemsRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ViewCollectionItemsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ViewCollectionItemsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ViewCollectionItemsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ViewCollectionItemsRequest must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ViewCollectionItemsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setCollection(String value)

public ViewCollectionItemsRequest.Builder setCollection(String value)

Required. The collection to view. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

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

Parameter
Name Description
value String

The collection to set.

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

setCollectionBytes(ByteString value)

public ViewCollectionItemsRequest.Builder setCollectionBytes(ByteString value)

Required. The collection to view. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/collections/{collection}

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

Parameter
Name Description
value ByteString

The bytes for collection to set.

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ViewCollectionItemsRequest.Builder setPageSize(int value)

The maximum number of collections to return. The service may return fewer than this value. If unspecified, at most 50 collections will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ViewCollectionItemsRequest.Builder setPageToken(String value)

A page token, received from a previous ViewCollectionItemsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ViewCollectionItemsRequest must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ViewCollectionItemsRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ViewCollectionItemsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ViewCollectionItemsRequest must match the call that provided the page token.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ViewCollectionItemsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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