Secret Manager V1beta2 Client - Class Rotation (2.1.1)

Reference documentation and code samples for the Secret Manager V1beta2 Client class Rotation.

The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation.

Generated from protobuf message google.cloud.secretmanager.v1beta2.Rotation

Namespace

Google \ Cloud \ SecretManager \ V1beta2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ next_rotation_time Google\Protobuf\Timestamp

Optional. Timestamp in UTC at which the Secret is scheduled to rotate. Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.
↳ rotation_period Google\Protobuf\Duration

Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years). If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.

getNextRotationTime

Optional. Timestamp in UTC at which the Secret is scheduled to rotate.

Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasNextRotationTime

clearNextRotationTime

setNextRotationTime

Optional. Timestamp in UTC at which the Secret is scheduled to rotate.

Cannot be set to less than 300s (5 min) in the future and at most 3153600000s (100 years). next_rotation_time MUST be set if rotation_period is set.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRotationPeriod

Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years).

If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.

Returns
Type Description
Google\Protobuf\Duration|null

hasRotationPeriod

clearRotationPeriod

setRotationPeriod

Input only. The Duration between rotation notifications. Must be in seconds and at least 3600s (1h) and at most 3153600000s (100 years).

If rotation_period is set, next_rotation_time must be set. next_rotation_time will be advanced by this period when the service automatically sends rotation notifications.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this