Google Cloud Dataplex V1 Client - Class DeleteDataProductRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class DeleteDataProductRequest.

Request message for deleting a data product.

Generated from protobuf message google.cloud.dataplex.v1.DeleteDataProductRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the data product to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}

↳ etag string

Optional. The etag of the data product. If an etag is provided and does not match the current etag of the data product, then the deletion will be blocked and an ABORTED error will be returned.

↳ validate_only bool

Optional. Validates the request without actually deleting the data product. Default: false.

getName

Required. The name of the data product to delete.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}

Returns
Type Description
string

setName

Required. The name of the data product to delete.

Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. The etag of the data product.

If an etag is provided and does not match the current etag of the data product, then the deletion will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

Optional. The etag of the data product.

If an etag is provided and does not match the current etag of the data product, then the deletion will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. Validates the request without actually deleting the data product.

Default: false.

Returns
Type Description
bool

setValidateOnly

Optional. Validates the request without actually deleting the data product.

Default: false.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the data product to delete. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id} Please see DataProductServiceClient::dataProductName() for help formatting this field.

Returns
Type Description
DeleteDataProductRequest