software.amazon.awssdk.services.organizations.model.Account Maven / Gradle / Ivy
Show all versions of organizations Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.organizations.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an Amazon Web Services account that is a member of an organization.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Account implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(Account::id)).setter(setter(Builder::id))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Id").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(Account::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField EMAIL_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Email")
.getter(getter(Account::email)).setter(setter(Builder::email))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Email").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(Account::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(Account::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField JOINED_METHOD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("JoinedMethod").getter(getter(Account::joinedMethodAsString)).setter(setter(Builder::joinedMethod))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JoinedMethod").build()).build();
private static final SdkField JOINED_TIMESTAMP_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("JoinedTimestamp").getter(getter(Account::joinedTimestamp)).setter(setter(Builder::joinedTimestamp))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("JoinedTimestamp").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
EMAIL_FIELD, NAME_FIELD, STATUS_FIELD, JOINED_METHOD_FIELD, JOINED_TIMESTAMP_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Id", ID_FIELD);
put("Arn", ARN_FIELD);
put("Email", EMAIL_FIELD);
put("Name", NAME_FIELD);
put("Status", STATUS_FIELD);
put("JoinedMethod", JOINED_METHOD_FIELD);
put("JoinedTimestamp", JOINED_TIMESTAMP_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String email;
private final String name;
private final String status;
private final String joinedMethod;
private final Instant joinedTimestamp;
private Account(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.email = builder.email;
this.name = builder.name;
this.status = builder.status;
this.joinedMethod = builder.joinedMethod;
this.joinedTimestamp = builder.joinedTimestamp;
}
/**
*
* The unique identifier (ID) of the account.
*
*
* The regex pattern for an account ID string requires exactly 12
* digits.
*
*
* @return The unique identifier (ID) of the account.
*
* The regex pattern for an account ID string requires exactly
* 12 digits.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the account.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.
*
*
* @return The Amazon Resource Name (ARN) of the account.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*/
public final String arn() {
return arn;
}
/**
*
* The email address associated with the Amazon Web Services account.
*
*
* The regex pattern for this parameter is a string of characters that
* represents a standard internet email address.
*
*
* @return The email address associated with the Amazon Web Services account.
*
* The regex pattern for this parameter is a string of
* characters that represents a standard internet email address.
*/
public final String email() {
return email;
}
/**
*
* The friendly name of the account.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @return The friendly name of the account.
*
* The regex pattern that is used to validate this parameter
* is a string of any of the characters in the ASCII character range.
*/
public final String name() {
return name;
}
/**
*
* The status of the account in the organization.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link AccountStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the account in the organization.
* @see AccountStatus
*/
public final AccountStatus status() {
return AccountStatus.fromValue(status);
}
/**
*
* The status of the account in the organization.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link AccountStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the account in the organization.
* @see AccountStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The method by which the account joined the organization.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #joinedMethod} will
* return {@link AccountJoinedMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #joinedMethodAsString}.
*
*
* @return The method by which the account joined the organization.
* @see AccountJoinedMethod
*/
public final AccountJoinedMethod joinedMethod() {
return AccountJoinedMethod.fromValue(joinedMethod);
}
/**
*
* The method by which the account joined the organization.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #joinedMethod} will
* return {@link AccountJoinedMethod#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #joinedMethodAsString}.
*
*
* @return The method by which the account joined the organization.
* @see AccountJoinedMethod
*/
public final String joinedMethodAsString() {
return joinedMethod;
}
/**
*
* The date the account became a part of the organization.
*
*
* @return The date the account became a part of the organization.
*/
public final Instant joinedTimestamp() {
return joinedTimestamp;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(email());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(joinedMethodAsString());
hashCode = 31 * hashCode + Objects.hashCode(joinedTimestamp());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Account)) {
return false;
}
Account other = (Account) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(email(), other.email())
&& Objects.equals(name(), other.name()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(joinedMethodAsString(), other.joinedMethodAsString())
&& Objects.equals(joinedTimestamp(), other.joinedTimestamp());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString.builder("Account").add("Id", id()).add("Arn", arn())
.add("Email", email() == null ? null : "*** Sensitive Data Redacted ***")
.add("Name", name() == null ? null : "*** Sensitive Data Redacted ***").add("Status", statusAsString())
.add("JoinedMethod", joinedMethodAsString()).add("JoinedTimestamp", joinedTimestamp()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Id":
return Optional.ofNullable(clazz.cast(id()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Email":
return Optional.ofNullable(clazz.cast(email()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "JoinedMethod":
return Optional.ofNullable(clazz.cast(joinedMethodAsString()));
case "JoinedTimestamp":
return Optional.ofNullable(clazz.cast(joinedTimestamp()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((Account) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The unique identifier (ID) of the account.
*
*
* The regex pattern for an account ID string requires exactly 12
* digits.
*
*
* @param id
* The unique identifier (ID) of the account.
*
* The regex pattern for an account ID string requires
* exactly 12 digits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder id(String id);
/**
*
* The Amazon Resource Name (ARN) of the account.
*
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the account.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization
* Reference.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The email address associated with the Amazon Web Services account.
*
*
* The regex pattern for this parameter is a string of characters
* that represents a standard internet email address.
*
*
* @param email
* The email address associated with the Amazon Web Services account.
*
* The regex pattern for this parameter is a string of
* characters that represents a standard internet email address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder email(String email);
/**
*
* The friendly name of the account.
*
*
* The regex pattern that is used to validate this parameter is a
* string of any of the characters in the ASCII character range.
*
*
* @param name
* The friendly name of the account.
*
* The regex pattern that is used to validate this
* parameter is a string of any of the characters in the ASCII character range.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The status of the account in the organization.
*
*
* @param status
* The status of the account in the organization.
* @see AccountStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountStatus
*/
Builder status(String status);
/**
*
* The status of the account in the organization.
*
*
* @param status
* The status of the account in the organization.
* @see AccountStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountStatus
*/
Builder status(AccountStatus status);
/**
*
* The method by which the account joined the organization.
*
*
* @param joinedMethod
* The method by which the account joined the organization.
* @see AccountJoinedMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountJoinedMethod
*/
Builder joinedMethod(String joinedMethod);
/**
*
* The method by which the account joined the organization.
*
*
* @param joinedMethod
* The method by which the account joined the organization.
* @see AccountJoinedMethod
* @return Returns a reference to this object so that method calls can be chained together.
* @see AccountJoinedMethod
*/
Builder joinedMethod(AccountJoinedMethod joinedMethod);
/**
*
* The date the account became a part of the organization.
*
*
* @param joinedTimestamp
* The date the account became a part of the organization.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder joinedTimestamp(Instant joinedTimestamp);
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String email;
private String name;
private String status;
private String joinedMethod;
private Instant joinedTimestamp;
private BuilderImpl() {
}
private BuilderImpl(Account model) {
id(model.id);
arn(model.arn);
email(model.email);
name(model.name);
status(model.status);
joinedMethod(model.joinedMethod);
joinedTimestamp(model.joinedTimestamp);
}
public final String getId() {
return id;
}
public final void setId(String id) {
this.id = id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getEmail() {
return email;
}
public final void setEmail(String email) {
this.email = email;
}
@Override
public final Builder email(String email) {
this.email = email;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(AccountStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getJoinedMethod() {
return joinedMethod;
}
public final void setJoinedMethod(String joinedMethod) {
this.joinedMethod = joinedMethod;
}
@Override
public final Builder joinedMethod(String joinedMethod) {
this.joinedMethod = joinedMethod;
return this;
}
@Override
public final Builder joinedMethod(AccountJoinedMethod joinedMethod) {
this.joinedMethod(joinedMethod == null ? null : joinedMethod.toString());
return this;
}
public final Instant getJoinedTimestamp() {
return joinedTimestamp;
}
public final void setJoinedTimestamp(Instant joinedTimestamp) {
this.joinedTimestamp = joinedTimestamp;
}
@Override
public final Builder joinedTimestamp(Instant joinedTimestamp) {
this.joinedTimestamp = joinedTimestamp;
return this;
}
@Override
public Account build() {
return new Account(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}