Cloud Vision V1 Client - Class PurgeProductsRequest (1.10.0)

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

Request message for the PurgeProducts method.

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

Namespace

Google \ Cloud \ Vision \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ product_set_purge_config Google\Cloud\Vision\V1\ProductSetPurgeConfig

Specify which ProductSet contains the Products to be deleted.

↳ delete_orphan_products bool

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

↳ parent string

Required. The project and location in which the Products should be deleted. Format is projects/PROJECT_ID/locations/LOC_ID.

↳ force bool

The default value is false. Override this value to true to actually perform the purge.

getProductSetPurgeConfig

Specify which ProductSet contains the Products to be deleted.

Returns
Type Description
Google\Cloud\Vision\V1\ProductSetPurgeConfig|null

hasProductSetPurgeConfig

setProductSetPurgeConfig

Specify which ProductSet contains the Products to be deleted.

Parameter
Name Description
var Google\Cloud\Vision\V1\ProductSetPurgeConfig
Returns
Type Description
$this

getDeleteOrphanProducts

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

Returns
Type Description
bool

hasDeleteOrphanProducts

setDeleteOrphanProducts

If delete_orphan_products is true, all Products that are not in any ProductSet will be deleted.

Parameter
Name Description
var bool
Returns
Type Description
$this

getParent

Required. The project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

Returns
Type Description
string

setParent

Required. The project and location in which the Products should be deleted.

Format is projects/PROJECT_ID/locations/LOC_ID.

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

The default value is false. Override this value to true to actually perform the purge.

Returns
Type Description
bool

setForce

The default value is false. Override this value to true to actually perform the purge.

Parameter
Name Description
var bool
Returns
Type Description
$this

getTarget

Returns
Type Description
string

static::build

Parameter
Name Description
parent string

Required. The project and location in which the Products should be deleted.

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

Returns
Type Description
Google\Cloud\Vision\V1\PurgeProductsRequest