Package com.oracle.bmc.vault.model

Class SecretExpiryRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.vault.model.SecretRule

com.oracle.bmc.vault.model.SecretExpiryRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180608")
public final class SecretExpiryRule
extends SecretRule

A rule that helps enforce the expiration of a secret’s contents.
Note: Objects should always be created or deserialized using the SecretExpiryRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SecretExpiryRule.Builder, which maintain a set of all explicitly set fields called SecretExpiryRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SecretExpiryRule.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.vault.model.SecretRule

SecretRule.RuleType

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SecretExpiryRule(String secretVersionExpiryInterval, Date timeOfAbsoluteExpiry, Boolean isSecretContentRetrievalBlockedOnExpiry)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SecretExpiryRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getIsSecretContentRetrievalBlockedOnExpiry()	A property indicating whether to block retrieval of the secret content, on expiry.
String	getSecretVersionExpiryInterval()	A property indicating how long the secret contents will be considered valid, expressed in ISO 8601 format.
Date	getTimeOfAbsoluteExpiry()	An optional property indicating the absolute time when this secret will expire, expressed in RFC 3339 timestamp format.
int	hashCode()
SecretExpiryRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecretExpiryRule

@Deprecated
public SecretExpiryRule(String secretVersionExpiryInterval,
                        Date timeOfAbsoluteExpiry,
                        Boolean isSecretContentRetrievalBlockedOnExpiry)

Deprecated.

Method Detail

builder

public static SecretExpiryRule.Builder builder()

Create a new builder.

toBuilder

public SecretExpiryRule.Builder toBuilder()

getSecretVersionExpiryInterval

public String getSecretVersionExpiryInterval()

A property indicating how long the secret contents will be considered valid, expressed in ISO 8601 format.

The secret needs to be updated when the secret content expires. The timer resets after you update the secret contents. The minimum value is 1 day and the maximum value is 90 days for this property. Currently, only intervals expressed in days are supported. For example, pass P3D to have the secret version expire every 3 days.

Returns:

the value

getTimeOfAbsoluteExpiry

public Date getTimeOfAbsoluteExpiry()

An optional property indicating the absolute time when this secret will expire, expressed in RFC 3339 timestamp format.

The minimum number of days from current time is 1 day and the maximum number of days from current time is 365 days. Example: 2019-04-03T21:10:29.600Z

Returns:

the value

getIsSecretContentRetrievalBlockedOnExpiry

public Boolean getIsSecretContentRetrievalBlockedOnExpiry()

A property indicating whether to block retrieval of the secret content, on expiry.

The default is false. If the secret has already expired and you would like to retrieve the secret contents, you need to edit the secret rule to disable this property, to allow reading the secret content.

Returns:

the value

toString

public String toString()

Overrides:

toString in class SecretRule

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class SecretRule

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class SecretRule

hashCode

public int hashCode()

Overrides:

hashCode in class SecretRule