software.amazon.awssdk.services.organizations.model.InviteAccountToOrganizationRequest 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.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.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class InviteAccountToOrganizationRequest extends OrganizationsRequest implements
ToCopyableBuilder {
private static final SdkField TARGET_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Target").getter(getter(InviteAccountToOrganizationRequest::target)).setter(setter(Builder::target))
.constructor(HandshakeParty::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Target").build()).build();
private static final SdkField NOTES_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Notes")
.getter(getter(InviteAccountToOrganizationRequest::notes)).setter(setter(Builder::notes))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Notes").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(InviteAccountToOrganizationRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TARGET_FIELD, NOTES_FIELD,
TAGS_FIELD));
private final HandshakeParty target;
private final String notes;
private final List tags;
private InviteAccountToOrganizationRequest(BuilderImpl builder) {
super(builder);
this.target = builder.target;
this.notes = builder.notes;
this.tags = builder.tags;
}
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is
* a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as the
* Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*
* @return The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number
* as the Id. If you specify "Type": "EMAIL", you must specify the email address
* that is associated with the account.
*
*
* --target [email protected],Type=EMAIL
*/
public final HandshakeParty target() {
return target;
}
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*
* @return Additional information that you want to include in the generated email to the recipient account owner.
*/
public final String notes() {
return notes;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each tag
* in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't
* set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The
* request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag
* policy compliance is not checked again when the invitation is accepted and the tags are actually
* attached to the account. That means that if the tag policy changes between the invitation and the acceptance,
* then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire
* request fails and invitations are not sent.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return A list of tags that you want to attach to the account when it becomes a member of the organization. For
* each tag in the list, you must specify both a tag key and a value. You can set the value to an empty
* string, but you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is
* made. The request is rejected if the tags in the request don't match the requirements of the policy at
* that time. Tag policy compliance is not checked again when the invitation is accepted and
* the tags are actually attached to the account. That means that if the tag policy changes between the
* invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
*/
public final List tags() {
return tags;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(target());
hashCode = 31 * hashCode + Objects.hashCode(notes());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof InviteAccountToOrganizationRequest)) {
return false;
}
InviteAccountToOrganizationRequest other = (InviteAccountToOrganizationRequest) obj;
return Objects.equals(target(), other.target()) && Objects.equals(notes(), other.notes()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("InviteAccountToOrganizationRequest").add("Target", target())
.add("Notes", notes() == null ? null : "*** Sensitive Data Redacted ***").add("Tags", hasTags() ? tags() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Target":
return Optional.ofNullable(clazz.cast(target()));
case "Notes":
return Optional.ofNullable(clazz.cast(notes()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((InviteAccountToOrganizationRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OrganizationsRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as
* the Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
*
* @param target
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your
* organization. This is a JSON object that contains the following elements:
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID
* number as the Id. If you specify "Type": "EMAIL", you must specify the email
* address that is associated with the account.
*
*
* --target [email protected],Type=EMAIL
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder target(HandshakeParty target);
/**
*
* The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.
* This is a JSON object that contains the following elements:
*
*
* { "Type": "ACCOUNT", "Id": "< account id number >" }
*
*
* If you use the CLI, you can submit this as a single string, similar to the following example:
*
*
* --target Id=123456789012,Type=ACCOUNT
*
*
* If you specify "Type": "ACCOUNT", you must provide the Amazon Web Services account ID number as
* the Id. If you specify "Type": "EMAIL", you must specify the email address that is
* associated with the account.
*
*
* --target [email protected],Type=EMAIL
*
* This is a convenience method that creates an instance of the {@link HandshakeParty.Builder} avoiding the need
* to create one manually via {@link HandshakeParty#builder()}.
*
*
* When the {@link Consumer} completes, {@link HandshakeParty.Builder#build()} is called immediately and its
* result is passed to {@link #target(HandshakeParty)}.
*
* @param target
* a consumer that will call methods on {@link HandshakeParty.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #target(HandshakeParty)
*/
default Builder target(Consumer target) {
return target(HandshakeParty.builder().applyMutation(target).build());
}
/**
*
* Additional information that you want to include in the generated email to the recipient account owner.
*
*
* @param notes
* Additional information that you want to include in the generated email to the recipient account owner.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder notes(String notes);
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each
* tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but
* you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made.
* The request is rejected if the tags in the request don't match the requirements of the policy at that time.
* Tag policy compliance is not checked again when the invitation is accepted and the tags are
* actually attached to the account. That means that if the tag policy changes between the invitation and the
* acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
*
*
* @param tags
* A list of tags that you want to attach to the account when it becomes a member of the organization.
* For each tag in the list, you must specify both a tag key and a value. You can set the value to an
* empty string, but you can't set it to null. For more information about tagging, see Tagging
* Organizations resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request
* is made. The request is rejected if the tags in the request don't match the requirements of the policy
* at that time. Tag policy compliance is not checked again when the invitation is
* accepted and the tags are actually attached to the account. That means that if the tag policy changes
* between the invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then
* the entire request fails and invitations are not sent.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each
* tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but
* you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made.
* The request is rejected if the tags in the request don't match the requirements of the policy at that time.
* Tag policy compliance is not checked again when the invitation is accepted and the tags are
* actually attached to the account. That means that if the tag policy changes between the invitation and the
* acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
*
*
* @param tags
* A list of tags that you want to attach to the account when it becomes a member of the organization.
* For each tag in the list, you must specify both a tag key and a value. You can set the value to an
* empty string, but you can't set it to null. For more information about tagging, see Tagging
* Organizations resources in the Organizations User Guide.
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request
* is made. The request is rejected if the tags in the request don't match the requirements of the policy
* at that time. Tag policy compliance is not checked again when the invitation is
* accepted and the tags are actually attached to the account. That means that if the tag policy changes
* between the invitation and the acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then
* the entire request fails and invitations are not sent.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags that you want to attach to the account when it becomes a member of the organization. For each
* tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but
* you can't set it to null. For more information about tagging, see Tagging Organizations
* resources in the Organizations User Guide.
*
*
*
* Any tags in the request are checked for compliance with any applicable tag policies when the request is made.
* The request is rejected if the tags in the request don't match the requirements of the policy at that time.
* Tag policy compliance is not checked again when the invitation is accepted and the tags are
* actually attached to the account. That means that if the tag policy changes between the invitation and the
* acceptance, then that tags could potentially be non-compliant.
*
*
*
* If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the
* entire request fails and invitations are not sent.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.organizations.model.Tag.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.organizations.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.organizations.model.Tag.Builder#build()} is called immediately and its
* result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.organizations.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OrganizationsRequest.BuilderImpl implements Builder {
private HandshakeParty target;
private String notes;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(InviteAccountToOrganizationRequest model) {
super(model);
target(model.target);
notes(model.notes);
tags(model.tags);
}
public final HandshakeParty.Builder getTarget() {
return target != null ? target.toBuilder() : null;
}
public final void setTarget(HandshakeParty.BuilderImpl target) {
this.target = target != null ? target.build() : null;
}
@Override
public final Builder target(HandshakeParty target) {
this.target = target;
return this;
}
public final String getNotes() {
return notes;
}
public final void setNotes(String notes) {
this.notes = notes;
}
@Override
public final Builder notes(String notes) {
this.notes = notes;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public InviteAccountToOrganizationRequest build() {
return new InviteAccountToOrganizationRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}