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

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
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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

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
Type Description
string

setName

Required. The name of the API resource to delete.

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

Parameter
Name Description
var string
Returns
Type Description
$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
Type Description
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
Name Description
var bool
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

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
Type Description
DeleteApiRequest