software.amazon.awssdk.services.organizations.model.Root 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.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about a root. A root is a top-level parent node in the hierarchy of an organization that can contain
* organizational units (OUs) and accounts. Every root contains every AWS account in the organization. Each root enables
* the accounts to be organized in a different way and to have different policy types enabled for use in that root.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Root implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ID_FIELD = SdkField. builder(MarshallingType.STRING).getter(getter(Root::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).getter(getter(Root::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)
.getter(getter(Root::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField> POLICY_TYPES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.getter(getter(Root::policyTypes))
.setter(setter(Builder::policyTypes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyTypes").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(PolicyTypeSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ID_FIELD, ARN_FIELD,
NAME_FIELD, POLICY_TYPES_FIELD));
private static final long serialVersionUID = 1L;
private final String id;
private final String arn;
private final String name;
private final List policyTypes;
private Root(BuilderImpl builder) {
this.id = builder.id;
this.arn = builder.arn;
this.name = builder.name;
this.policyTypes = builder.policyTypes;
}
/**
*
* The unique identifier (ID) for the root.
*
*
* The regex pattern for a root ID string requires "r-" followed by
* from 4 to 32 lower-case letters or digits.
*
*
* @return The unique identifier (ID) for the root.
*
* The regex pattern for a root ID string requires "r-"
* followed by from 4 to 32 lower-case letters or digits.
*/
public String id() {
return id;
}
/**
*
* The Amazon Resource Name (ARN) of the root.
*
*
* For more information about ARNs in Organizations, see ARN
* Formats Supported by Organizations in the AWS Organizations User Guide.
*
*
* @return The Amazon Resource Name (ARN) of the root.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
*/
public String arn() {
return arn;
}
/**
*
* The friendly name of the root.
*
*
* 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 root.
*
* The regex pattern that is used to validate this parameter
* is a string of any of the characters in the ASCII character range.
*/
public String name() {
return name;
}
/**
* Returns true if the PolicyTypes property was specified by the sender (it may be empty), or false if the sender
* did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public boolean hasPolicyTypes() {
return policyTypes != null && !(policyTypes instanceof SdkAutoConstructList);
}
/**
*
* The types of policies that are currently enabled for the root and therefore can be attached to the root or to its
* OUs or accounts.
*
*
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable them at
* the root level by using EnablePolicyType and DisablePolicyType. Use DescribeOrganization to
* see the availability of the policy types in that organization.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasPolicyTypes()} to see if a value was sent in this field.
*
*
* @return The types of policies that are currently enabled for the root and therefore can be attached to the root
* or to its OUs or accounts.
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable
* them at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
*/
public List policyTypes() {
return policyTypes;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(id());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(policyTypes());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof Root)) {
return false;
}
Root other = (Root) obj;
return Objects.equals(id(), other.id()) && Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(policyTypes(), other.policyTypes());
}
/**
* 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 String toString() {
return ToString.builder("Root").add("Id", id()).add("Arn", arn()).add("Name", name()).add("PolicyTypes", policyTypes())
.build();
}
public 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()));
case "PolicyTypes":
return Optional.ofNullable(clazz.cast(policyTypes()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Root) 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) for the root.
*
*
* The regex pattern for a root ID string requires "r-" followed
* by from 4 to 32 lower-case letters or digits.
*
*
* @param id
* The unique identifier (ID) for the root.
*
* The regex pattern for a root ID string requires "r-"
* followed by from 4 to 32 lower-case 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 the root.
*
*
* For more information about ARNs in Organizations, see ARN
* Formats Supported by Organizations in the AWS Organizations User Guide.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the root.
*
* For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The friendly name of the root.
*
*
* 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 root.
*
* 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 types of policies that are currently enabled for the root and therefore can be attached to the root or to
* its OUs or accounts.
*
*
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable them
* at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
*
*
* @param policyTypes
* The types of policies that are currently enabled for the root and therefore can be attached to the
* root or to its OUs or accounts.
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable
* them at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyTypes(Collection policyTypes);
/**
*
* The types of policies that are currently enabled for the root and therefore can be attached to the root or to
* its OUs or accounts.
*
*
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable them
* at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
*
*
* @param policyTypes
* The types of policies that are currently enabled for the root and therefore can be attached to the
* root or to its OUs or accounts.
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable
* them at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyTypes(PolicyTypeSummary... policyTypes);
/**
*
* The types of policies that are currently enabled for the root and therefore can be attached to the root or to
* its OUs or accounts.
*
*
*
* Even if a policy type is shown as available in the organization, you can separately enable and disable them
* at the root level by using EnablePolicyType and DisablePolicyType. Use
* DescribeOrganization to see the availability of the policy types in that organization.
*
* This is a convenience that creates an instance of the {@link List.Builder}
* avoiding the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately
* and its result is passed to {@link #policyTypes(List)}.
*
* @param policyTypes
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #policyTypes(List)
*/
Builder policyTypes(Consumer... policyTypes);
}
static final class BuilderImpl implements Builder {
private String id;
private String arn;
private String name;
private List policyTypes = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Root model) {
id(model.id);
arn(model.arn);
name(model.name);
policyTypes(model.policyTypes);
}
public final String getId() {
return id;
}
@Override
public final Builder id(String id) {
this.id = id;
return this;
}
public final void setId(String id) {
this.id = id;
}
public final String getArn() {
return arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final void setArn(String arn) {
this.arn = arn;
}
public final String getName() {
return name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final void setName(String name) {
this.name = name;
}
public final Collection getPolicyTypes() {
return policyTypes != null ? policyTypes.stream().map(PolicyTypeSummary::toBuilder).collect(Collectors.toList())
: null;
}
@Override
public final Builder policyTypes(Collection policyTypes) {
this.policyTypes = PolicyTypesCopier.copy(policyTypes);
return this;
}
@Override
@SafeVarargs
public final Builder policyTypes(PolicyTypeSummary... policyTypes) {
policyTypes(Arrays.asList(policyTypes));
return this;
}
@Override
@SafeVarargs
public final Builder policyTypes(Consumer... policyTypes) {
policyTypes(Stream.of(policyTypes).map(c -> PolicyTypeSummary.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setPolicyTypes(Collection policyTypes) {
this.policyTypes = PolicyTypesCopier.copyFromBuilder(policyTypes);
}
@Override
public Root build() {
return new Root(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}