Google Cloud Api Keys V2 Client - Class DeleteKeyRequest (0.2.2)

Reference documentation and code samples for the Google Cloud Api Keys V2 Client class DeleteKeyRequest.

Request message for DeleteKey method.

Generated from protobuf message google.api.apikeys.v2.DeleteKeyRequest

Namespace

Google \ Cloud \ ApiKeys \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The resource name of the API key to be deleted.

↳ etag string

Optional. The etag known to the client for the expected state of the key. This is to be used for optimistic concurrency.

getName

Required. The resource name of the API key to be deleted.

Returns
TypeDescription
string

setName

Required. The resource name of the API key to be deleted.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEtag

Optional. The etag known to the client for the expected state of the key.

This is to be used for optimistic concurrency.

Returns
TypeDescription
string

setEtag

Optional. The etag known to the client for the expected state of the key.

This is to be used for optimistic concurrency.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The resource name of the API key to be deleted. Please see Google\Cloud\ApiKeys\V2\ApiKeysClient::keyName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\ApiKeys\V2\DeleteKeyRequest