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

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

Request message for ViewIndexedAssets.

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

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ index string

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

↳ page_size int

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.

↳ page_token string

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.

↳ filter string

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.

getIndex

Required. The index that owns this collection of assets.

Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

Returns
Type Description
string

setIndex

Required. The index that owns this collection of assets.

Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{index}

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
int

setPageSize

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.

Parameter
Name Description
var int
Returns
Type Description
$this

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.

Returns
Type Description
string

setPageToken

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

setFilter

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.

Parameter
Name Description
var string
Returns
Type Description
$this