Google Cloud Design Center V1 Client - Class DeleteCatalogRequest (0.1.0)

Reference documentation and code samples for the Google Cloud Design Center V1 Client class DeleteCatalogRequest.

Message for deleting a catalog.

Generated from protobuf message google.cloud.designcenter.v1.DeleteCatalogRequest

Namespace

Google \ Cloud \ DesignCenter \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

↳ force bool

Optional. If set to true, the catalog's children are also deleted. If false, the catalog is only deleted if it has no children.

getName

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

Returns
Type Description
string

setName

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog

Parameter
Name Description
var string
Returns
Type Description
$this

getForce

Optional. If set to true, the catalog's children are also deleted. If false, the catalog is only deleted if it has no children.

Returns
Type Description
bool

setForce

Optional. If set to true, the catalog's children are also deleted. If false, the catalog is only deleted if it has no children.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The catalog name in the following format: projects/$project/locations/$location/spaces/$space/catalogs/$catalog Please see DesignCenterClient::catalogName() for help formatting this field.

Returns
Type Description
DeleteCatalogRequest