Google Cloud Api Hub V1 Client - Class DeleteApiRequest (0.2.0)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class DeleteApiRequest.

The DeleteApi method's request.

Generated from protobuf message google.cloud.apihub.v1.DeleteApiRequest

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

Required. The name of the API resource to delete. Format: projects/{project}/locations/{location}/apis/{api}

↳ forcebool

Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.

getName

Required. The name of the API resource to delete.

Format: projects/{project}/locations/{location}/apis/{api}

Returns
TypeDescription
string

setName

Required. The name of the API resource to delete.

Format: projects/{project}/locations/{location}/apis/{api}

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getForce

Optional. If set to true, any versions from this API will also be deleted.

Otherwise, the request will only work if the API has no versions.

Returns
TypeDescription
bool

setForce

Optional. If set to true, any versions from this API will also be deleted.

Otherwise, the request will only work if the API has no versions.

Parameter
NameDescription
varbool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
namestring

Required. The name of the API resource to delete. Format: projects/{project}/locations/{location}/apis/{api} Please see ApiHubClient::apiName() for help formatting this field.

Returns
TypeDescription
DeleteApiRequest