software.amazon.awssdk.services.organizations.model.OrganizationalUnit 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.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 details about an organizational unit (OU). An OU is a container of Amazon Web Services accounts within a
* root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any
* child OUs.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class OrganizationalUnit implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Id")
.getter(getter(OrganizationalUnit::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(OrganizationalUnit::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(OrganizationalUnit::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("Id", ID_FIELD);
put("Arn", ARN_FIELD);
put("Name", NAME_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private OrganizationalUnit(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
}
/**
*
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string
* is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*
* @return The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
* The regex pattern for an organizational unit ID string
* requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the
* OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or
* digits.
*/
public final String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of this OU.
*
*
* 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 this OU.
*
* 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 friendly name of this OU.
*
*
* 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 this OU.
*
* 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;
}
@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(name());
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 OrganizationalUnit)) {
return false;
}
OrganizationalUnit other = (OrganizationalUnit) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name());
}
/**
* 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("OrganizationalUnit").add("Id", id()).add("Arn", arn()).add("Name", name()).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 "Name":
return Optional.ofNullable(clazz.cast(name()));
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((OrganizationalUnit) 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) associated with this OU. The ID is unique to the organization only.
*
*
* The regex pattern for an organizational unit ID string requires
* "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This
* string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits.
*
*
* @param id
* The unique identifier (ID) associated with this OU. The ID is unique to the organization only.
*
* The regex pattern for an organizational unit ID string
* requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains
* the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or
* 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 this OU.
*
*
* 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 this OU.
*
* 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 friendly name of this OU.
*
*
* 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 this OU.
*
* 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);
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String name;
private BuilderImpl() {
}
private BuilderImpl(OrganizationalUnit model) {
id(model.id);
arn(model.arn);
name(model.name);
}
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 getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
@Override
public OrganizationalUnit build() {
return new OrganizationalUnit(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}