com.oracle.bmc.identity.model.AuthToken Maven / Gradle / Ivy
/**
* Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
*/
package com.oracle.bmc.identity.model;
/**
* An `AuthToken` is an Oracle-generated token string that you can use to authenticate with third-party APIs
* that do not support Oracle Cloud Infrastructure's signature-based authentication. For example, use an `AuthToken`
* to authenticate with a Swift client with the Object Storage Service.
*
* The auth token is associated with the user's Console login. Auth tokens never expire. A user can have up to two
* auth tokens at a time.
*
**Note:** The token 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.cloud.oracle.com/Content/Identity/Tasks/managingcredentials.htm).
*
*
* 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 #__explicitlySet__}. The {@link #hashCode()} and {@link #equals(Object)} methods are implemented to take
* {@link #__explicitlySet__} into account. The constructor, on the other hand, does not set {@link #__explicitlySet__}
* (since the constructor cannot distinguish explicit {@code null} from unset {@code null}).
**/
@javax.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20160918")
@lombok.AllArgsConstructor(onConstructor = @__({@Deprecated}))
@lombok.Value
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = AuthToken.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(com.oracle.bmc.http.internal.ExplicitlySetFilter.NAME)
public class AuthToken {
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
@lombok.experimental.Accessors(fluent = true)
public static class Builder {
@com.fasterxml.jackson.annotation.JsonProperty("token")
private String token;
public Builder token(String token) {
this.token = token;
this.__explicitlySet__.add("token");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("userId")
private String userId;
public Builder userId(String userId) {
this.userId = userId;
this.__explicitlySet__.add("userId");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("description")
private String description;
public Builder description(String description) {
this.description = description;
this.__explicitlySet__.add("description");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
public Builder timeCreated(java.util.Date timeCreated) {
this.timeCreated = timeCreated;
this.__explicitlySet__.add("timeCreated");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("timeExpires")
private java.util.Date timeExpires;
public Builder timeExpires(java.util.Date timeExpires) {
this.timeExpires = timeExpires;
this.__explicitlySet__.add("timeExpires");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private LifecycleState lifecycleState;
public Builder lifecycleState(LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("inactiveStatus")
private Long inactiveStatus;
public Builder inactiveStatus(Long inactiveStatus) {
this.inactiveStatus = inactiveStatus;
this.__explicitlySet__.add("inactiveStatus");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public AuthToken build() {
AuthToken __instance__ =
new AuthToken(
token,
id,
userId,
description,
timeCreated,
timeExpires,
lifecycleState,
inactiveStatus);
__instance__.__explicitlySet__.addAll(__explicitlySet__);
return __instance__;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(AuthToken o) {
Builder copiedBuilder =
token(o.getToken())
.id(o.getId())
.userId(o.getUserId())
.description(o.getDescription())
.timeCreated(o.getTimeCreated())
.timeExpires(o.getTimeExpires())
.lifecycleState(o.getLifecycleState())
.inactiveStatus(o.getInactiveStatus());
copiedBuilder.__explicitlySet__.retainAll(o.__explicitlySet__);
return copiedBuilder;
}
}
/**
* Create a new builder.
*/
public static Builder builder() {
return new Builder();
}
/**
* The auth token. The value is available only in the response for `CreateAuthToken`, and not
* for `ListAuthTokens` or `UpdateAuthToken`.
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("token")
String token;
/**
* The OCID of the auth token.
**/
@com.fasterxml.jackson.annotation.JsonProperty("id")
String id;
/**
* The OCID of the user the auth token belongs to.
**/
@com.fasterxml.jackson.annotation.JsonProperty("userId")
String userId;
/**
* The description you assign to the auth token. Does not have to be unique, and it's changeable.
**/
@com.fasterxml.jackson.annotation.JsonProperty("description")
String description;
/**
* Date and time the `AuthToken` object was created, in the format defined by RFC3339.
*
* Example: `2016-08-25T21:10:29.600Z`
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
java.util.Date timeCreated;
/**
* Date and time when this auth token will expire, in the format defined by RFC3339.
* Null if it never expires.
*
* Example: `2016-08-25T21:10:29.600Z`
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("timeExpires")
java.util.Date timeExpires;
/**
* The token's current state. After creating an auth token, make sure its `lifecycleState` changes from
* CREATING to ACTIVE before using it.
*
**/
@lombok.extern.slf4j.Slf4j
public enum LifecycleState {
Creating("CREATING"),
Active("ACTIVE"),
Inactive("INACTIVE"),
Deleting("DELETING"),
Deleted("DELETED"),
/**
* 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 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 token's current state. After creating an auth token, make sure its `lifecycleState` changes from
* CREATING to ACTIVE before using it.
*
**/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
LifecycleState lifecycleState;
/**
* The detailed status of INACTIVE lifecycleState.
**/
@com.fasterxml.jackson.annotation.JsonProperty("inactiveStatus")
Long inactiveStatus;
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
}