Secret Manager V1 Client - Class DeleteSecretRequest (1.15.2)

Reference documentation and code samples for the Secret Manager V1 Client class DeleteSecretRequest.

Request message for SecretManagerService.DeleteSecret.

Generated from protobuf message google.cloud.secretmanager.v1.DeleteSecretRequest

Namespace

Google \ Cloud \ SecretManager \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

Required. The resource name of the Secret to delete in the format projects/*/secrets/*.
↳ etag string

Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.

getName

Required. The resource name of the Secret to delete in the format projects/*/secrets/*.

Returns
Type Description
string

setName

Required. The resource name of the Secret to delete in the format projects/*/secrets/*.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.

Returns
Type Description
string

setEtag

Optional. Etag of the Secret. The request succeeds if it matches the etag of the currently stored secret object. If the etag is omitted, the request succeeds.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The resource name of the Secret to delete in the format projects/*/secrets/*. Please see Google\Cloud\SecretManager\V1\SecretManagerServiceClient::secretName() for help formatting this field.
Returns
Type Description
Google\Cloud\SecretManager\V1\DeleteSecretRequest