Cloud Vision V1 Client - Class ProductSet (1.7.6)

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

A ProductSet contains Products. A ProductSet can contain a maximum of 1 million reference images. If the limit is exceeded, periodic indexing will fail.

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

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The resource name of the ProductSet. Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

↳ display_name string

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

↳ index_time Google\Protobuf\Timestamp

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet.

↳ index_error Google\Rpc\Status

Output only. If there was an error with indexing the product set, the field is populated. This field is ignored when creating a ProductSet.

getName

The resource name of the ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

Returns
TypeDescription
string

setName

The resource name of the ProductSet.

Format is: projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID. This field is ignored when creating a ProductSet.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

Returns
TypeDescription
string

setDisplayName

The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getIndexTime

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z".

This field is ignored when creating a ProductSet.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasIndexTime

clearIndexTime

setIndexTime

Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z".

This field is ignored when creating a ProductSet.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getIndexError

Output only. If there was an error with indexing the product set, the field is populated.

This field is ignored when creating a ProductSet.

Returns
TypeDescription
Google\Rpc\Status|null

hasIndexError

clearIndexError

setIndexError

Output only. If there was an error with indexing the product set, the field is populated.

This field is ignored when creating a ProductSet.

Parameter
NameDescription
var Google\Rpc\Status
Returns
TypeDescription
$this