Package com.oracle.bmc.identity.model

Class CustomerSecretKey

java.lang.Object

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

com.oracle.bmc.identity.model.CustomerSecretKey

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CustomerSecretKey
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A CustomerSecretKey is an Oracle-provided key for using the Object Storage Service’s Amazon S3 compatible API.

The key consists of a secret key/access key pair. 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](https://docs.oracle.com/iaas/Content/Identity/access/managing-user-credentials.htm).
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 CustomerSecretKey.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	CustomerSecretKey.Builder
static class	CustomerSecretKey.LifecycleState	The secret key’s current state.

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
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	Description
static CustomerSecretKey.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDisplayName()	The display name you assign to the secret key.
String	getId()	The access key portion of the key pair.
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()
CustomerSecretKey.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

CustomerSecretKey

@Deprecated
@ConstructorProperties({"key","id","userId","displayName","timeCreated","timeExpires","lifecycleState","inactiveStatus"})
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.

toBuilder

public CustomerSecretKey.Builder toBuilder()

getKey

public String getKey()

The secret key.

Returns:

the value

getId

public String getId()

The access key portion of the key pair.

Returns:

the value

getUserId

public String getUserId()

The OCID of the user the password belongs to.

Returns:

the value

getDisplayName

public String getDisplayName()

The display name you assign to the secret key.

Does not have to be unique, and it’s changeable.

Returns:

the value

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

Returns:

the value

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

Returns:

the value

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.

Returns:

the value

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel