com.oracle.bmc.bds.model.BdsApiKey Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-shaded-full Show documentation
Show all versions of oci-java-sdk-shaded-full Show documentation
This project contains the SDK distribution used for Oracle Cloud Infrastructure, and all the dependencies that can be shaded. It also has Maven dependencies that cannot be shaded. Therefore, use this module to depend on the shaded distribution via Maven -- it will shade everything that can be shaded, and automatically pull in the other dependencies.
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.bds.model;
/**
* The API key information.
* Note: Objects should always be created or deserialized using the {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #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 {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190531")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = BdsApiKey.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class BdsApiKey extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"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,
java.util.Date timeCreated,
LifecycleState lifecycleState) {
super();
this.id = id;
this.userId = userId;
this.keyAlias = keyAlias;
this.defaultRegion = defaultRegion;
this.tenantId = tenantId;
this.fingerprint = fingerprint;
this.pemfilepath = pemfilepath;
this.timeCreated = timeCreated;
this.lifecycleState = lifecycleState;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** Identifier of the user's API key. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* Identifier of the user's API key.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/** The user OCID for which this API key was created. */
@com.fasterxml.jackson.annotation.JsonProperty("userId")
private String userId;
/**
* The user OCID for which this API key was created.
*
* @param userId the value to set
* @return this builder
*/
public Builder userId(String userId) {
this.userId = userId;
this.__explicitlySet__.add("userId");
return this;
}
/**
* User friendly identifier used to uniquely differentiate between different API keys. Only
* ASCII alphanumeric characters with no spaces allowed.
*/
@com.fasterxml.jackson.annotation.JsonProperty("keyAlias")
private String keyAlias;
/**
* User friendly identifier used to uniquely differentiate between different API keys. Only
* ASCII alphanumeric characters with no spaces allowed.
*
* @param keyAlias the value to set
* @return this builder
*/
public Builder keyAlias(String keyAlias) {
this.keyAlias = keyAlias;
this.__explicitlySet__.add("keyAlias");
return this;
}
/**
* The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
*/
@com.fasterxml.jackson.annotation.JsonProperty("defaultRegion")
private String defaultRegion;
/**
* The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
*
* @param defaultRegion the value to set
* @return this builder
*/
public Builder defaultRegion(String defaultRegion) {
this.defaultRegion = defaultRegion;
this.__explicitlySet__.add("defaultRegion");
return this;
}
/** The OCID of your tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("tenantId")
private String tenantId;
/**
* The OCID of your tenancy.
*
* @param tenantId the value to set
* @return this builder
*/
public Builder tenantId(String tenantId) {
this.tenantId = tenantId;
this.__explicitlySet__.add("tenantId");
return this;
}
/** The fingerprint that corresponds to the public API key requested. */
@com.fasterxml.jackson.annotation.JsonProperty("fingerprint")
private String fingerprint;
/**
* The fingerprint that corresponds to the public API key requested.
*
* @param fingerprint the value to set
* @return this builder
*/
public Builder fingerprint(String fingerprint) {
this.fingerprint = fingerprint;
this.__explicitlySet__.add("fingerprint");
return this;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("pemfilepath")
private String pemfilepath;
/**
* 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.
*
* @param pemfilepath the value to set
* @return this builder
*/
public Builder pemfilepath(String pemfilepath) {
this.pemfilepath = pemfilepath;
this.__explicitlySet__.add("pemfilepath");
return this;
}
/** The time the API key was created, shown as an RFC 3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
/**
* The time the API key was created, shown as an RFC 3339 formatted datetime string.
*
* @param timeCreated the value to set
* @return this builder
*/
public Builder timeCreated(java.util.Date timeCreated) {
this.timeCreated = timeCreated;
this.__explicitlySet__.add("timeCreated");
return this;
}
/** The state of the key. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private LifecycleState lifecycleState;
/**
* The state of the key.
*
* @param lifecycleState the value to set
* @return this builder
*/
public Builder lifecycleState(LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public BdsApiKey build() {
BdsApiKey model =
new BdsApiKey(
this.id,
this.userId,
this.keyAlias,
this.defaultRegion,
this.tenantId,
this.fingerprint,
this.pemfilepath,
this.timeCreated,
this.lifecycleState);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(BdsApiKey model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("userId")) {
this.userId(model.getUserId());
}
if (model.wasPropertyExplicitlySet("keyAlias")) {
this.keyAlias(model.getKeyAlias());
}
if (model.wasPropertyExplicitlySet("defaultRegion")) {
this.defaultRegion(model.getDefaultRegion());
}
if (model.wasPropertyExplicitlySet("tenantId")) {
this.tenantId(model.getTenantId());
}
if (model.wasPropertyExplicitlySet("fingerprint")) {
this.fingerprint(model.getFingerprint());
}
if (model.wasPropertyExplicitlySet("pemfilepath")) {
this.pemfilepath(model.getPemfilepath());
}
if (model.wasPropertyExplicitlySet("timeCreated")) {
this.timeCreated(model.getTimeCreated());
}
if (model.wasPropertyExplicitlySet("lifecycleState")) {
this.lifecycleState(model.getLifecycleState());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** Identifier of the user's API key. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* Identifier of the user's API key.
*
* @return the value
*/
public String getId() {
return id;
}
/** The user OCID for which this API key was created. */
@com.fasterxml.jackson.annotation.JsonProperty("userId")
private final String userId;
/**
* The user OCID for which this API key was created.
*
* @return the value
*/
public String getUserId() {
return userId;
}
/**
* User friendly identifier used to uniquely differentiate between different API keys. Only
* ASCII alphanumeric characters with no spaces allowed.
*/
@com.fasterxml.jackson.annotation.JsonProperty("keyAlias")
private final String keyAlias;
/**
* User friendly identifier used to uniquely differentiate between different API keys. Only
* ASCII alphanumeric characters with no spaces allowed.
*
* @return the value
*/
public String getKeyAlias() {
return keyAlias;
}
/** The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 . */
@com.fasterxml.jackson.annotation.JsonProperty("defaultRegion")
private final String defaultRegion;
/**
* The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .
*
* @return the value
*/
public String getDefaultRegion() {
return defaultRegion;
}
/** The OCID of your tenancy. */
@com.fasterxml.jackson.annotation.JsonProperty("tenantId")
private final String tenantId;
/**
* The OCID of your tenancy.
*
* @return the value
*/
public String getTenantId() {
return tenantId;
}
/** The fingerprint that corresponds to the public API key requested. */
@com.fasterxml.jackson.annotation.JsonProperty("fingerprint")
private final String fingerprint;
/**
* The fingerprint that corresponds to the public API key requested.
*
* @return the value
*/
public String getFingerprint() {
return fingerprint;
}
/**
* 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.
*/
@com.fasterxml.jackson.annotation.JsonProperty("pemfilepath")
private final String pemfilepath;
/**
* 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.
*
* @return the value
*/
public String getPemfilepath() {
return pemfilepath;
}
/** The time the API key was created, shown as an RFC 3339 formatted datetime string. */
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private final java.util.Date timeCreated;
/**
* The time the API key was created, shown as an RFC 3339 formatted datetime string.
*
* @return the value
*/
public java.util.Date getTimeCreated() {
return timeCreated;
}
/** The state of the key. */
public enum LifecycleState implements com.oracle.bmc.http.internal.BmcEnum {
Creating("CREATING"),
Active("ACTIVE"),
Deleting("DELETING"),
Deleted("DELETED"),
Failed("FAILED"),
/**
* This value is used if a service returns a value for this enum that is not recognized by
* this version of the SDK.
*/
UnknownEnumValue(null);
private static final org.slf4j.Logger LOG =
org.slf4j.LoggerFactory.getLogger(LifecycleState.class);
private final String value;
private static java.util.Map map;
static {
map = new java.util.HashMap<>();
for (LifecycleState v : LifecycleState.values()) {
if (v != UnknownEnumValue) {
map.put(v.getValue(), v);
}
}
}
LifecycleState(String value) {
this.value = value;
}
@com.fasterxml.jackson.annotation.JsonValue
public String getValue() {
return value;
}
@com.fasterxml.jackson.annotation.JsonCreator
public static LifecycleState create(String key) {
if (map.containsKey(key)) {
return map.get(key);
}
LOG.warn(
"Received unknown value '{}' for enum 'LifecycleState', returning UnknownEnumValue",
key);
return UnknownEnumValue;
}
};
/** The state of the key. */
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private final LifecycleState lifecycleState;
/**
* The state of the key.
*
* @return the value
*/
public LifecycleState getLifecycleState() {
return lifecycleState;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("BdsApiKey(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", userId=").append(String.valueOf(this.userId));
sb.append(", keyAlias=").append(String.valueOf(this.keyAlias));
sb.append(", defaultRegion=").append(String.valueOf(this.defaultRegion));
sb.append(", tenantId=").append(String.valueOf(this.tenantId));
sb.append(", fingerprint=").append(String.valueOf(this.fingerprint));
sb.append(", pemfilepath=").append(String.valueOf(this.pemfilepath));
sb.append(", timeCreated=").append(String.valueOf(this.timeCreated));
sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof BdsApiKey)) {
return false;
}
BdsApiKey other = (BdsApiKey) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.userId, other.userId)
&& java.util.Objects.equals(this.keyAlias, other.keyAlias)
&& java.util.Objects.equals(this.defaultRegion, other.defaultRegion)
&& java.util.Objects.equals(this.tenantId, other.tenantId)
&& java.util.Objects.equals(this.fingerprint, other.fingerprint)
&& java.util.Objects.equals(this.pemfilepath, other.pemfilepath)
&& java.util.Objects.equals(this.timeCreated, other.timeCreated)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = 1;
result = (result * PRIME) + (this.id == null ? 43 : this.id.hashCode());
result = (result * PRIME) + (this.userId == null ? 43 : this.userId.hashCode());
result = (result * PRIME) + (this.keyAlias == null ? 43 : this.keyAlias.hashCode());
result =
(result * PRIME)
+ (this.defaultRegion == null ? 43 : this.defaultRegion.hashCode());
result = (result * PRIME) + (this.tenantId == null ? 43 : this.tenantId.hashCode());
result = (result * PRIME) + (this.fingerprint == null ? 43 : this.fingerprint.hashCode());
result = (result * PRIME) + (this.pemfilepath == null ? 43 : this.pemfilepath.hashCode());
result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy