Google Cloud BigQuery Analytics Hub V1 Client - Class DeleteListingRequest (1.2.0)

Reference documentation and code samples for the Google Cloud BigQuery Analytics Hub V1 Client class DeleteListingRequest.

Message for deleting a listing.

Generated from protobuf message google.cloud.bigquery.analyticshub.v1.DeleteListingRequest

Namespace

Google \ Cloud \ BigQuery \ AnalyticsHub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Resource name of the listing to delete. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

↳ delete_commercial bool

Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.

getName

Required. Resource name of the listing to delete.

e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

Returns
Type Description
string

setName

Required. Resource name of the listing to delete.

e.g. projects/myproject/locations/us/dataExchanges/123/listings/456.

Parameter
Name Description
var string
Returns
Type Description
$this

getDeleteCommercial

Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.

Returns
Type Description
bool

setDeleteCommercial

Optional. If the listing is commercial then this field must be set to true, otherwise a failure is thrown. This acts as a safety guard to avoid deleting commercial listings accidentally.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of the listing to delete. e.g. projects/myproject/locations/us/dataExchanges/123/listings/456. Please see AnalyticsHubServiceClient::listingName() for help formatting this field.

Returns
Type Description
DeleteListingRequest