Cloud Vision V1 Client - Class ListReferenceImagesRequest (1.9.3)

Reference documentation and code samples for the Cloud Vision V1 Client class ListReferenceImagesRequest.

Request message for the ListReferenceImages method.

Generated from protobuf message google.cloud.vision.v1.ListReferenceImagesRequest

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. Resource name of the product containing the reference images. Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
`↳ page_size`	`int` The maximum number of items to return. Default 10, maximum 100.
`↳ page_token`	`string` A token identifying a page of results to be returned. This is the value of `nextPageToken` returned in a previous reference image list request. Defaults to the first page if not specified.

getParent

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Returns
Type	Description
`string`

setParent

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The maximum number of items to return. Default 10, maximum 100.

Returns
Type	Description
`int`

setPageSize

The maximum number of items to return. Default 10, maximum 100.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.

Returns
Type	Description
`string`

setPageToken

A token identifying a page of results to be returned. This is the value of nextPageToken returned in a previous reference image list request.

Defaults to the first page if not specified.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter

Name Description

parent

string

Required. Resource name of the product containing the reference images.

Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID. Please see Google\Cloud\Vision\V1\ProductSearchClient::productName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\Vision\V1\ListReferenceImagesRequest`