Interface ViewCollectionItemsRequestOrBuilder (0.2.0)

public interface ViewCollectionItemsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCollection()

public abstract 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 abstract 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.

getPageSize()

public abstract 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 abstract 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 abstract 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.