Package com.oracle.bmc.bds.model

Class BdsApiKeySummary

java.lang.Object

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

com.oracle.bmc.bds.model.BdsApiKeySummary

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

The API key summary.
Note: Objects should always be created or deserialized using the BdsApiKeySummary.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 BdsApiKeySummary.Builder, which maintain a set of all explicitly set fields called BdsApiKeySummary.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	BdsApiKeySummary.Builder

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
BdsApiKeySummary(String id, String keyAlias, BdsApiKey.LifecycleState lifecycleState, String defaultRegion, Date timeCreated)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static BdsApiKeySummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDefaultRegion()	The name of the region to establish the Object Storage endpoint which was set as part of key creation operation.
String	getId()	Identifier of the user’s API key.
String	getKeyAlias()	User friendly identifier used to uniquely differentiate between different API keys.
BdsApiKey.LifecycleState	getLifecycleState()	The current status of the API key.
Date	getTimeCreated()	The time the API key was created, shown as an RFC 3339 formatted datetime string.
int	hashCode()
BdsApiKeySummary.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

BdsApiKeySummary

@Deprecated
@ConstructorProperties({"id","keyAlias","lifecycleState","defaultRegion","timeCreated"})
public BdsApiKeySummary(String id,
                        String keyAlias,
                        BdsApiKey.LifecycleState lifecycleState,
                        String defaultRegion,
                        Date timeCreated)

Deprecated.

Method Detail

builder

public static BdsApiKeySummary.Builder builder()

Create a new builder.

toBuilder

public BdsApiKeySummary.Builder toBuilder()

getId

public String getId()

Identifier of the user’s API key.

Returns:

the value

getKeyAlias

public String getKeyAlias()

User friendly identifier used to uniquely differentiate between different API keys.

Only ASCII alphanumeric characters with no spaces allowed.

Returns:

the value

getLifecycleState

public BdsApiKey.LifecycleState getLifecycleState()

The current status of the API key.

Returns:

the value

getDefaultRegion

public String getDefaultRegion()

The name of the region to establish the Object Storage endpoint which was set as part of key creation operation.

If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the API key was created, shown as an RFC 3339 formatted datetime string.

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