Class ViewIndexedAssetsRequest.Builder (0.8.0)

public static final class ViewIndexedAssetsRequest.Builder extends GeneratedMessageV3.Builder<ViewIndexedAssetsRequest.Builder> implements ViewIndexedAssetsRequestOrBuilder

Request message for ViewIndexedAssets.

Protobuf type google.cloud.visionai.v1.ViewIndexedAssetsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ViewIndexedAssetsRequest build()
Returns
Type Description
ViewIndexedAssetsRequest

buildPartial()

public ViewIndexedAssetsRequest buildPartial()
Returns
Type Description
ViewIndexedAssetsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearFilter()

public ViewIndexedAssetsRequest.Builder clearFilter()

The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.

string filter = 4;

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

clearIndex()

public ViewIndexedAssetsRequest.Builder clearIndex()

Required. The index that owns this collection of assets. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

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

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ViewIndexedAssetsRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

clearPageToken()

public ViewIndexedAssetsRequest.Builder clearPageToken()

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

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

string page_token = 3;

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ViewIndexedAssetsRequest getDefaultInstanceForType()
Returns
Type Description
ViewIndexedAssetsRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.

string filter = 4;

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.

string filter = 4;

Returns
Type Description
ByteString

The bytes for filter.

getIndex()

public String getIndex()

Required. The index that owns this collection of assets. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

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

Returns
Type Description
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

Required. The index that owns this collection of assets. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

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

Returns
Type Description
ByteString

The bytes for index.

getPageSize()

public int getPageSize()

The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets 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 ViewIndexedAssets call. Provide this to retrieve the subsequent page.

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

When paginating, all other parameters provided to ViewIndexedAssets 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(ViewIndexedAssetsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setFilter(String value)

public ViewIndexedAssetsRequest.Builder setFilter(String value)

The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.

string filter = 4;

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ViewIndexedAssetsRequest.Builder setFilterBytes(ByteString value)

The filter applied to the returned list. Only the following filterings are supported: "asset_id = xxxx", which returns asset with specified id. "asset_id = xxxx, yyyy, zzzz", which returns assets with specified ids.

string filter = 4;

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

setIndex(String value)

public ViewIndexedAssetsRequest.Builder setIndex(String value)

Required. The index that owns this collection of assets. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

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

Parameter
Name Description
value String

The index to set.

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

setIndexBytes(ByteString value)

public ViewIndexedAssetsRequest.Builder setIndexBytes(ByteString value)

Required. The index that owns this collection of assets. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

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

Parameter
Name Description
value ByteString

The bytes for index to set.

Returns
Type Description
ViewIndexedAssetsRequest.Builder

This builder for chaining.

setPageSize(int value)

public ViewIndexedAssetsRequest.Builder setPageSize(int value)

The maximum number of assets to return. The service may return fewer than this value. If unspecified, at most 50 assets 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
ViewIndexedAssetsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ViewIndexedAssetsRequest.Builder setPageToken(String value)

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

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

This builder for chaining.

setPageTokenBytes(ByteString value)

public ViewIndexedAssetsRequest.Builder setPageTokenBytes(ByteString value)

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

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

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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