Google Cloud Apigee Registry V1 Client - Class DeleteApiRequest (0.4.2)

Reference documentation and code samples for the Google Cloud Apigee Registry V1 Client class DeleteApiRequest.

Request message for DeleteApi.

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

Namespace

Google \ Cloud \ ApigeeRegistry \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the API to delete. Format: projects/*/locations/*/apis/*

↳ force bool

If set to true, any child resources will also be deleted. (Otherwise, the request will only work if there are no child resources.)

getName

Required. The name of the API to delete.

Format: projects/*/locations/*/apis/*

Returns
TypeDescription
string

setName

Required. The name of the API to delete.

Format: projects/*/locations/*/apis/*

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getForce

If set to true, any child resources will also be deleted.

(Otherwise, the request will only work if there are no child resources.)

Returns
TypeDescription
bool

setForce

If set to true, any child resources will also be deleted.

(Otherwise, the request will only work if there are no child resources.)

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the API to delete. Format: projects/*/locations/*/apis/* Please see Google\Cloud\ApigeeRegistry\V1\RegistryClient::apiName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\ApigeeRegistry\V1\DeleteApiRequest