Google Cloud Vision Ai V1 Client - Class ListCollectionsRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class ListCollectionsRequest.

Request message for ListCollections.

Generated from protobuf message google.cloud.visionai.v1.ListCollectionsRequest

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ page_size int

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.

↳ page_token string

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.

getParent

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

Returns
Type Description
string

setParent

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

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this