Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class Expiration (4.8.0)

public sealed class Expiration

Expiration specified by relative timeout or absolute deadline.

Inheritance

object > Expiration

Google.Api.Gax.dll

public DateTime? Deadline { get; }

If not null, the absolute deadline of this expiration.

Property Value
Type	Description
`DateTime`

public static Expiration None { get; }

An Expiration with no timeout or deadline.

Property Value
Type	Description
`Expiration`

Remarks

Indicates that no expiration is required.

public TimeSpan? Timeout { get; }

If not null, the relative timeout of this expiration.

Property Value
Type	Description
`TimeSpan`

public ExpirationType Type { get; }

What ExpirationType is contained in this Expiration.

Property Value
Type	Description
`ExpirationType`

public static Expiration FromDeadline(DateTime deadline)

Create an Expiration with an absolute deadline.

Parameter
Name	Description
`deadline`	`DateTime` The absolute deadline. Should be a UTC datetime.

Returns
Type	Description
`Expiration`	An Expiration with the specified absolute deadline.

Remarks

Deadlines in the past are valid, and will cause immediate failure of the operation being performed.

public static Expiration FromTimeout(TimeSpan timeout)

Create an Expiration with a relative timeout.

Parameter
Name	Description
`timeout`	`TimeSpan` The relative timeout.

Returns
Type	Description
`Expiration`	An Expiration with the specified relative timeout.

Remarks

Zero or negative timeouts are valid, and will cause immediate failure of the operation being performed.