Class ViewIndexedAssetsRequest (0.5.0)

public final class ViewIndexedAssetsRequest extends GeneratedMessageV3 implements ViewIndexedAssetsRequestOrBuilder

Request message for ViewIndexedAssets.

Protobuf type google.cloud.visionai.v1.ViewIndexedAssetsRequest

Static Fields

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

INDEX_FIELD_NUMBER

public static final int INDEX_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ViewIndexedAssetsRequest getDefaultInstance()
Returns
Type Description
ViewIndexedAssetsRequest

getDescriptor()

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

newBuilder()

public static ViewIndexedAssetsRequest.Builder newBuilder()
Returns
Type Description
ViewIndexedAssetsRequest.Builder

newBuilder(ViewIndexedAssetsRequest prototype)

public static ViewIndexedAssetsRequest.Builder newBuilder(ViewIndexedAssetsRequest prototype)
Parameter
Name Description
prototype ViewIndexedAssetsRequest
Returns
Type Description
ViewIndexedAssetsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ViewIndexedAssetsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ViewIndexedAssetsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ViewIndexedAssetsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ViewIndexedAssetsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ViewIndexedAssetsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ViewIndexedAssetsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ViewIndexedAssetsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ViewIndexedAssetsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ViewIndexedAssetsRequest> parser()
Returns
Type Description
Parser<ViewIndexedAssetsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ViewIndexedAssetsRequest getDefaultInstanceForType()
Returns
Type Description
ViewIndexedAssetsRequest

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.

getParserForType()

public Parser<ViewIndexedAssetsRequest> getParserForType()
Returns
Type Description
Parser<ViewIndexedAssetsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ViewIndexedAssetsRequest.Builder newBuilderForType()
Returns
Type Description
ViewIndexedAssetsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ViewIndexedAssetsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ViewIndexedAssetsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ViewIndexedAssetsRequest.Builder toBuilder()
Returns
Type Description
ViewIndexedAssetsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException