com.oracle.bmc.identity.model

Class CustomerSecretKey

java.lang.Object

com.oracle.bmc.identity.model.CustomerSecretKey

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CustomerSecretKey
extends Object

A CustomerSecretKey is an Oracle-provided key for using the Object Storage Service’s Amazon S3 compatible API. A user can have up to two secret keys at a time.

Note:* The secret key is always an Oracle-generated string; you can’t change it to a string of your choice.

For more information, see Managing User Credentials.

Note: Objects should always be created or deserialized using the CustomerSecretKey.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 CustomerSecretKey.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomerSecretKey.Builder
static class	CustomerSecretKey.LifecycleState The secret key’s current state.

Constructor Summary

Constructors

Constructor and Description
CustomerSecretKey(String key, String id, String userId, String displayName, Date timeCreated, Date timeExpires, CustomerSecretKey.LifecycleState lifecycleState, Long inactiveStatus) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CustomerSecretKey.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getDisplayName() The display name you assign to the secret key.
String	getId() The OCID of the secret key.
Long	getInactiveStatus() The detailed status of INACTIVE lifecycleState.
String	getKey() The secret key.
CustomerSecretKey.LifecycleState	getLifecycleState() The secret key’s current state.
Date	getTimeCreated() Date and time the CustomerSecretKey object was created, in the format defined by RFC3339.
Date	getTimeExpires() Date and time when this password will expire, in the format defined by RFC3339.
String	getUserId() The OCID of the user the password belongs to.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomerSecretKey

@ConstructorProperties(value={"key","id","userId","displayName","timeCreated","timeExpires","lifecycleState","inactiveStatus"})
 @Deprecated
public CustomerSecretKey(String key,
                                                                                                                                                                      String id,
                                                                                                                                                                      String userId,
                                                                                                                                                                      String displayName,
                                                                                                                                                                      Date timeCreated,
                                                                                                                                                                      Date timeExpires,
                                                                                                                                                                      CustomerSecretKey.LifecycleState lifecycleState,
                                                                                                                                                                      Long inactiveStatus)

Deprecated.

Method Detail

builder

public static CustomerSecretKey.Builder builder()

Create a new builder.

getKey

public String getKey()

The secret key.

getId

public String getId()

The OCID of the secret key.

getUserId

public String getUserId()

The OCID of the user the password belongs to.

getDisplayName

public String getDisplayName()

The display name you assign to the secret key. Does not have to be unique, and it’s changeable.

getTimeCreated

public Date getTimeCreated()

Date and time the CustomerSecretKey object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

getTimeExpires

public Date getTimeExpires()

Date and time when this password will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

getLifecycleState

public CustomerSecretKey.LifecycleState getLifecycleState()

The secret key’s current state. After creating a secret key, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object