Class ListCollectionsRequest.Builder (0.3.0)

public static final class ListCollectionsRequest.Builder extends GeneratedMessageV3.Builder<ListCollectionsRequest.Builder> implements ListCollectionsRequestOrBuilder

Request message for ListCollections.

Protobuf type google.cloud.visionai.v1.ListCollectionsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListCollectionsRequest build()
Returns
Type Description
ListCollectionsRequest

buildPartial()

public ListCollectionsRequest buildPartial()
Returns
Type Description
ListCollectionsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListCollectionsRequest.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
ListCollectionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListCollectionsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns
Type Description
ListCollectionsRequest.Builder

This builder for chaining.

clearParent()

public ListCollectionsRequest.Builder clearParent()

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Returns
Type Description
ListCollectionsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListCollectionsRequest getDefaultInstanceForType()
Returns
Type Description
ListCollectionsRequest

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 ListCollectionsRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCollectionsRequest 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 ListCollectionsRequest call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListCollectionsRequest.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
ListCollectionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListCollectionsRequest.Builder setPageToken(String value)

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

When paginating, all other parameters provided to ListCollectionsRequest 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
ListCollectionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListCollectionsRequest.Builder setPageTokenBytes(ByteString value)

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

When paginating, all other parameters provided to ListCollectionsRequest 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
ListCollectionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListCollectionsRequest.Builder setParent(String value)

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListCollectionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListCollectionsRequest.Builder setParentBytes(ByteString value)

Required. The parent corpus. Format: projects/{project_number}/locations/{location}/corpora/{corpus}

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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