Cloud Vision V1 Client - Class CreateReferenceImageRequest (1.8.0)

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

Request message for the CreateReferenceImage method.

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

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. Resource name of the product in which to create the reference image. Format is projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID.

↳ reference_image Google\Cloud\Vision\V1\ReferenceImage

Required. The reference image to create. If an image ID is specified, it is ignored.

↳ reference_image_id string

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

getParent

Required. Resource name of the product in which to create the reference image.

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

Returns
TypeDescription
string

setParent

Required. Resource name of the product in which to create the reference image.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReferenceImage

Required. The reference image to create.

If an image ID is specified, it is ignored.

Returns
TypeDescription
Google\Cloud\Vision\V1\ReferenceImage|null

hasReferenceImage

clearReferenceImage

setReferenceImage

Required. The reference image to create.

If an image ID is specified, it is ignored.

Parameter
NameDescription
var Google\Cloud\Vision\V1\ReferenceImage
Returns
TypeDescription
$this

getReferenceImageId

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Returns
TypeDescription
string

setReferenceImageId

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. Resource name of the product in which to create the reference image.

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

referenceImage Google\Cloud\Vision\V1\ReferenceImage

Required. The reference image to create. If an image ID is specified, it is ignored.

referenceImageId string

A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character /.

Returns
TypeDescription
Google\Cloud\Vision\V1\CreateReferenceImageRequest