Cloud PubSub V1 Client - Class ExpirationPolicy (2.5.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class ExpirationPolicy.

A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion).

Generated from protobuf message google.pubsub.v1.ExpirationPolicy

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ ttl Google\Protobuf\Duration

Optional. Specifies the "time-to-live" duration for an associated resource. The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

getTtl

Optional. Specifies the "time-to-live" duration for an associated resource.

The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

Returns
Type Description
Google\Protobuf\Duration|null

hasTtl

clearTtl

setTtl

Optional. Specifies the "time-to-live" duration for an associated resource.

The resource expires if it is not active for a period of ttl. The definition of "activity" depends on the type of the associated resource. The minimum and maximum allowed values for ttl depend on the type of the associated resource, as well. If ttl is not set, the associated resource never expires.

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