com.oracle.bmc.identity.model.IdpGroupMapping Maven / Gradle / Ivy
/**
* 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.identity.model;
/**
* A mapping between a single group defined by the identity provider (IdP) you're federating with
* and a single IAM Service {@link Group} in Oracle Cloud Infrastructure. For more information about
* group mappings and what they're for, see [Identity Providers and
* Federation](https://docs.cloud.oracle.com/Content/Identity/Concepts/federation.htm).
*
* A given IdP group can be mapped to zero, one, or multiple IAM Service groups, and vice versa.
* But each {@code IdPGroupMapping} object is between only a single IdP group and IAM Service group.
* Each {@code IdPGroupMapping} object has its own OCID.
*
*
*Note:** Any users who are in more than 50 IdP groups cannot be authenticated to use the
* Oracle Cloud Infrastructure Console.
* 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: 20160918")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(builder = IdpGroupMapping.Builder.class)
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class IdpGroupMapping
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel {
@Deprecated
@java.beans.ConstructorProperties({
"id",
"idpId",
"idpGroupName",
"groupId",
"compartmentId",
"timeCreated",
"lifecycleState",
"inactiveStatus"
})
public IdpGroupMapping(
String id,
String idpId,
String idpGroupName,
String groupId,
String compartmentId,
java.util.Date timeCreated,
LifecycleState lifecycleState,
Long inactiveStatus) {
super();
this.id = id;
this.idpId = idpId;
this.idpGroupName = idpGroupName;
this.groupId = groupId;
this.compartmentId = compartmentId;
this.timeCreated = timeCreated;
this.lifecycleState = lifecycleState;
this.inactiveStatus = inactiveStatus;
}
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
/** The OCID of the {@code IdpGroupMapping}. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private String id;
/**
* The OCID of the {@code IdpGroupMapping}.
*
* @param id the value to set
* @return this builder
*/
public Builder id(String id) {
this.id = id;
this.__explicitlySet__.add("id");
return this;
}
/** The OCID of the {@code IdentityProvider} this mapping belongs to. */
@com.fasterxml.jackson.annotation.JsonProperty("idpId")
private String idpId;
/**
* The OCID of the {@code IdentityProvider} this mapping belongs to.
*
* @param idpId the value to set
* @return this builder
*/
public Builder idpId(String idpId) {
this.idpId = idpId;
this.__explicitlySet__.add("idpId");
return this;
}
/** The name of the IdP group that is mapped to the IAM Service group. */
@com.fasterxml.jackson.annotation.JsonProperty("idpGroupName")
private String idpGroupName;
/**
* The name of the IdP group that is mapped to the IAM Service group.
*
* @param idpGroupName the value to set
* @return this builder
*/
public Builder idpGroupName(String idpGroupName) {
this.idpGroupName = idpGroupName;
this.__explicitlySet__.add("idpGroupName");
return this;
}
/** The OCID of the IAM Service group that is mapped to the IdP group. */
@com.fasterxml.jackson.annotation.JsonProperty("groupId")
private String groupId;
/**
* The OCID of the IAM Service group that is mapped to the IdP group.
*
* @param groupId the value to set
* @return this builder
*/
public Builder groupId(String groupId) {
this.groupId = groupId;
this.__explicitlySet__.add("groupId");
return this;
}
/** The OCID of the tenancy containing the {@code IdentityProvider}. */
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private String compartmentId;
/**
* The OCID of the tenancy containing the {@code IdentityProvider}.
*
* @param compartmentId the value to set
* @return this builder
*/
public Builder compartmentId(String compartmentId) {
this.compartmentId = compartmentId;
this.__explicitlySet__.add("compartmentId");
return this;
}
/**
* Date and time the mapping was created, in the format defined by RFC3339.
*
*
Example: {@code 2016-08-25T21:10:29.600Z}
*/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private java.util.Date timeCreated;
/**
* Date and time the mapping was created, in the format defined by RFC3339.
*
*
Example: {@code 2016-08-25T21:10:29.600Z}
*
* @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 mapping's current state. After creating a mapping object, make sure its {@code
* lifecycleState} changes from CREATING to ACTIVE before using it.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private LifecycleState lifecycleState;
/**
* The mapping's current state. After creating a mapping object, make sure its {@code
* lifecycleState} changes from CREATING to ACTIVE before using it.
*
* @param lifecycleState the value to set
* @return this builder
*/
public Builder lifecycleState(LifecycleState lifecycleState) {
this.lifecycleState = lifecycleState;
this.__explicitlySet__.add("lifecycleState");
return this;
}
/** The detailed status of INACTIVE lifecycleState. */
@com.fasterxml.jackson.annotation.JsonProperty("inactiveStatus")
private Long inactiveStatus;
/**
* The detailed status of INACTIVE lifecycleState.
*
* @param inactiveStatus the value to set
* @return this builder
*/
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 IdpGroupMapping build() {
IdpGroupMapping model =
new IdpGroupMapping(
this.id,
this.idpId,
this.idpGroupName,
this.groupId,
this.compartmentId,
this.timeCreated,
this.lifecycleState,
this.inactiveStatus);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(IdpGroupMapping model) {
if (model.wasPropertyExplicitlySet("id")) {
this.id(model.getId());
}
if (model.wasPropertyExplicitlySet("idpId")) {
this.idpId(model.getIdpId());
}
if (model.wasPropertyExplicitlySet("idpGroupName")) {
this.idpGroupName(model.getIdpGroupName());
}
if (model.wasPropertyExplicitlySet("groupId")) {
this.groupId(model.getGroupId());
}
if (model.wasPropertyExplicitlySet("compartmentId")) {
this.compartmentId(model.getCompartmentId());
}
if (model.wasPropertyExplicitlySet("timeCreated")) {
this.timeCreated(model.getTimeCreated());
}
if (model.wasPropertyExplicitlySet("lifecycleState")) {
this.lifecycleState(model.getLifecycleState());
}
if (model.wasPropertyExplicitlySet("inactiveStatus")) {
this.inactiveStatus(model.getInactiveStatus());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
/** The OCID of the {@code IdpGroupMapping}. */
@com.fasterxml.jackson.annotation.JsonProperty("id")
private final String id;
/**
* The OCID of the {@code IdpGroupMapping}.
*
* @return the value
*/
public String getId() {
return id;
}
/** The OCID of the {@code IdentityProvider} this mapping belongs to. */
@com.fasterxml.jackson.annotation.JsonProperty("idpId")
private final String idpId;
/**
* The OCID of the {@code IdentityProvider} this mapping belongs to.
*
* @return the value
*/
public String getIdpId() {
return idpId;
}
/** The name of the IdP group that is mapped to the IAM Service group. */
@com.fasterxml.jackson.annotation.JsonProperty("idpGroupName")
private final String idpGroupName;
/**
* The name of the IdP group that is mapped to the IAM Service group.
*
* @return the value
*/
public String getIdpGroupName() {
return idpGroupName;
}
/** The OCID of the IAM Service group that is mapped to the IdP group. */
@com.fasterxml.jackson.annotation.JsonProperty("groupId")
private final String groupId;
/**
* The OCID of the IAM Service group that is mapped to the IdP group.
*
* @return the value
*/
public String getGroupId() {
return groupId;
}
/** The OCID of the tenancy containing the {@code IdentityProvider}. */
@com.fasterxml.jackson.annotation.JsonProperty("compartmentId")
private final String compartmentId;
/**
* The OCID of the tenancy containing the {@code IdentityProvider}.
*
* @return the value
*/
public String getCompartmentId() {
return compartmentId;
}
/**
* Date and time the mapping was created, in the format defined by RFC3339.
*
* Example: {@code 2016-08-25T21:10:29.600Z}
*/
@com.fasterxml.jackson.annotation.JsonProperty("timeCreated")
private final java.util.Date timeCreated;
/**
* Date and time the mapping was created, in the format defined by RFC3339.
*
*
Example: {@code 2016-08-25T21:10:29.600Z}
*
* @return the value
*/
public java.util.Date getTimeCreated() {
return timeCreated;
}
/**
* The mapping's current state. After creating a mapping object, make sure its {@code
* lifecycleState} changes from CREATING to ACTIVE before using it.
*/
public enum LifecycleState implements com.oracle.bmc.http.internal.BmcEnum {
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 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 mapping's current state. After creating a mapping object, make sure its {@code
* lifecycleState} changes from CREATING to ACTIVE before using it.
*/
@com.fasterxml.jackson.annotation.JsonProperty("lifecycleState")
private final LifecycleState lifecycleState;
/**
* The mapping's current state. After creating a mapping object, make sure its {@code
* lifecycleState} changes from CREATING to ACTIVE before using it.
*
* @return the value
*/
public LifecycleState getLifecycleState() {
return lifecycleState;
}
/** The detailed status of INACTIVE lifecycleState. */
@com.fasterxml.jackson.annotation.JsonProperty("inactiveStatus")
private final Long inactiveStatus;
/**
* The detailed status of INACTIVE lifecycleState.
*
* @return the value
*/
public Long getInactiveStatus() {
return inactiveStatus;
}
@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("IdpGroupMapping(");
sb.append("super=").append(super.toString());
sb.append("id=").append(String.valueOf(this.id));
sb.append(", idpId=").append(String.valueOf(this.idpId));
sb.append(", idpGroupName=").append(String.valueOf(this.idpGroupName));
sb.append(", groupId=").append(String.valueOf(this.groupId));
sb.append(", compartmentId=").append(String.valueOf(this.compartmentId));
sb.append(", timeCreated=").append(String.valueOf(this.timeCreated));
sb.append(", lifecycleState=").append(String.valueOf(this.lifecycleState));
sb.append(", inactiveStatus=").append(String.valueOf(this.inactiveStatus));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof IdpGroupMapping)) {
return false;
}
IdpGroupMapping other = (IdpGroupMapping) o;
return java.util.Objects.equals(this.id, other.id)
&& java.util.Objects.equals(this.idpId, other.idpId)
&& java.util.Objects.equals(this.idpGroupName, other.idpGroupName)
&& java.util.Objects.equals(this.groupId, other.groupId)
&& java.util.Objects.equals(this.compartmentId, other.compartmentId)
&& java.util.Objects.equals(this.timeCreated, other.timeCreated)
&& java.util.Objects.equals(this.lifecycleState, other.lifecycleState)
&& java.util.Objects.equals(this.inactiveStatus, other.inactiveStatus)
&& 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.idpId == null ? 43 : this.idpId.hashCode());
result = (result * PRIME) + (this.idpGroupName == null ? 43 : this.idpGroupName.hashCode());
result = (result * PRIME) + (this.groupId == null ? 43 : this.groupId.hashCode());
result =
(result * PRIME)
+ (this.compartmentId == null ? 43 : this.compartmentId.hashCode());
result = (result * PRIME) + (this.timeCreated == null ? 43 : this.timeCreated.hashCode());
result =
(result * PRIME)
+ (this.lifecycleState == null ? 43 : this.lifecycleState.hashCode());
result =
(result * PRIME)
+ (this.inactiveStatus == null ? 43 : this.inactiveStatus.hashCode());
result = (result * PRIME) + super.hashCode();
return result;
}
}