Secret Manager V1 Client - Class DisableSecretVersionRequest (1.11.0)

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

Request message for SecretManagerService.DisableSecretVersion.

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

Methods

build

Parameter
Name	Description
`name`	`string` Required. The resource name of the SecretVersion to disable in the format `projects//secrets//versions/*`. Please see {@see \Google\Cloud\SecretManager\V1\SecretManagerServiceClient::secretVersionName()} for help formatting this field.

Returns
Type	Description
`Google\Cloud\SecretManager\V1\DisableSecretVersionRequest`

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The resource name of the SecretVersion to disable in the format `projects//secrets//versions/*`.
`↳ etag`	`string` Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds.

getName

Required. The resource name of the SecretVersion to disable in the format projects/*/secrets/*/versions/*.

Returns
Type	Description
`string`

setName

Required. The resource name of the SecretVersion to disable in the format projects/*/secrets/*/versions/*.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEtag

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

Returns
Type	Description
`string`

setEtag

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`