com.oracle.bmc.bds.model

Class BdsApiKey

java.lang.Object

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

com.oracle.bmc.bds.model.BdsApiKey

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

The API key information.
Note: Objects should always be created or deserialized using the BdsApiKey.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 BdsApiKey.Builder, which maintain a set of all explicitly set fields called BdsApiKey.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 and Description
static class	BdsApiKey.Builder
static class	BdsApiKey.LifecycleState The state of the key.

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 and Description
BdsApiKey(String id, String userId, String keyAlias, String defaultRegion, String tenantId, String fingerprint, String pemfilepath, Date timeCreated, BdsApiKey.LifecycleState lifecycleState) Deprecated.

Method Summary

Modifier and Type	Method and Description
static BdsApiKey.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getDefaultRegion() The name of the region to establish the Object Storage endpoint.
String	getFingerprint() The fingerprint that corresponds to the public API key requested.
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 state of the key.
String	getPemfilepath() The full path and file name of the private key used for authentication.
String	getTenantId() The OCID of your tenancy.
Date	getTimeCreated() The time the API key was created, shown as an RFC 3339 formatted datetime string.
String	getUserId() The user OCID for which this API key was created.
int	hashCode()
BdsApiKey.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

BdsApiKey

@Deprecated
 @ConstructorProperties(value={"id","userId","keyAlias","defaultRegion","tenantId","fingerprint","pemfilepath","timeCreated","lifecycleState"})
public BdsApiKey(String id,
                                                                                                                                                                             String userId,
                                                                                                                                                                             String keyAlias,
                                                                                                                                                                             String defaultRegion,
                                                                                                                                                                             String tenantId,
                                                                                                                                                                             String fingerprint,
                                                                                                                                                                             String pemfilepath,
                                                                                                                                                                             Date timeCreated,
                                                                                                                                                                             BdsApiKey.LifecycleState lifecycleState)

Deprecated.

Method Detail

builder

public static BdsApiKey.Builder builder()

Create a new builder.

toBuilder

public BdsApiKey.Builder toBuilder()

getId

public String getId()

Identifier of the user’s API key.

Returns:

the value

getUserId

public String getUserId()

The user OCID for which this API key was created.

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

getDefaultRegion

public String getDefaultRegion()

The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .

Returns:

the value

getTenantId

public String getTenantId()

The OCID of your tenancy.

Returns:

the value

getFingerprint

public String getFingerprint()

The fingerprint that corresponds to the public API key requested.

Returns:

the value

getPemfilepath

public String getPemfilepath()

The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system.

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

getLifecycleState

public BdsApiKey.LifecycleState getLifecycleState()

The state of the key.

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