software.amazon.awssdk.services.organizations.model.HandshakeResource Maven / Gradle / Ivy
/*
* 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 additional data that is needed to process a handshake.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class HandshakeResource implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(HandshakeResource::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(HandshakeResource::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField> RESOURCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Resources")
.getter(getter(HandshakeResource::resources))
.setter(setter(Builder::resources))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Resources").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HandshakeResource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VALUE_FIELD, TYPE_FIELD,
RESOURCES_FIELD));
private static final long serialVersionUID = 1L;
private final String value;
private final String type;
private final List resources;
private HandshakeResource(BuilderImpl builder) {
this.value = builder.value;
this.type = builder.type;
this.resources = builder.resources;
}
/**
*
* The information that is passed to the other party in the handshake. The format of the value string must match the
* requirements of the specified type.
*
*
* @return The information that is passed to the other party in the handshake. The format of the value string must
* match the requirements of the specified type.
*/
public final String value() {
return value;
}
/**
*
* The type of information being passed, specifying how the value is to be interpreted by the other party:
*
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included as
* information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as information
* about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link HandshakeResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of information being passed, specifying how the value is to be interpreted by the other
* party:
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included
* as information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as
* information about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient
* to read.
*
*
* @see HandshakeResourceType
*/
public final HandshakeResourceType type() {
return HandshakeResourceType.fromValue(type);
}
/**
*
* The type of information being passed, specifying how the value is to be interpreted by the other party:
*
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included as
* information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as information
* about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient to read.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link HandshakeResourceType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of information being passed, specifying how the value is to be interpreted by the other
* party:
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included
* as information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as
* information about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient
* to read.
*
*
* @see HandshakeResourceType
*/
public final String typeAsString() {
return type;
}
/**
* For responses, this returns true if the service returned a value for the Resources 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 hasResources() {
return resources != null && !(resources instanceof SdkAutoConstructList);
}
/**
*
* When needed, contains an additional array of HandshakeResource objects.
*
*
* 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 #hasResources} method.
*
*
* @return When needed, contains an additional array of HandshakeResource objects.
*/
public final List resources() {
return resources;
}
@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(value());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasResources() ? resources() : null);
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 HandshakeResource)) {
return false;
}
HandshakeResource other = (HandshakeResource) obj;
return Objects.equals(value(), other.value()) && Objects.equals(typeAsString(), other.typeAsString())
&& hasResources() == other.hasResources() && Objects.equals(resources(), other.resources());
}
/**
* 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("HandshakeResource").add("Value", value() == null ? null : "*** Sensitive Data Redacted ***")
.add("Type", typeAsString()).add("Resources", hasResources() ? resources() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Value":
return Optional.ofNullable(clazz.cast(value()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Resources":
return Optional.ofNullable(clazz.cast(resources()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((HandshakeResource) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The information that is passed to the other party in the handshake. The format of the value string must match
* the requirements of the specified type.
*
*
* @param value
* The information that is passed to the other party in the handshake. The format of the value string
* must match the requirements of the specified type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
/**
*
* The type of information being passed, specifying how the value is to be interpreted by the other party:
*
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included as
* information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as information
* about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient to
* read.
*
*
*
*
* @param type
* The type of information being passed, specifying how the value is to be interpreted by the other
* party:
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account.
* Included as information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as
* information about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the
* recipient to read.
*
*
* @see HandshakeResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see HandshakeResourceType
*/
Builder type(String type);
/**
*
* The type of information being passed, specifying how the value is to be interpreted by the other party:
*
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account. Included as
* information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as information
* about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the recipient to
* read.
*
*
*
*
* @param type
* The type of information being passed, specifying how the value is to be interpreted by the other
* party:
*
* -
*
* ACCOUNT - Specifies an Amazon Web Services account ID number.
*
*
* -
*
* ORGANIZATION - Specifies an organization ID number.
*
*
* -
*
* EMAIL - Specifies the email address that is associated with the account that receives the
* handshake.
*
*
* -
*
* OWNER_EMAIL - Specifies the email address associated with the management account.
* Included as information about an organization.
*
*
* -
*
* OWNER_NAME - Specifies the name associated with the management account. Included as
* information about an organization.
*
*
* -
*
* NOTES - Additional text provided by the handshake initiator and intended for the
* recipient to read.
*
*
* @see HandshakeResourceType
* @return Returns a reference to this object so that method calls can be chained together.
* @see HandshakeResourceType
*/
Builder type(HandshakeResourceType type);
/**
*
* When needed, contains an additional array of HandshakeResource objects.
*
*
* @param resources
* When needed, contains an additional array of HandshakeResource objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resources(Collection resources);
/**
*
* When needed, contains an additional array of HandshakeResource objects.
*
*
* @param resources
* When needed, contains an additional array of HandshakeResource objects.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resources(HandshakeResource... resources);
/**
*
* When needed, contains an additional array of HandshakeResource objects.
*
* This is a convenience method 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 #resources(List)}.
*
* @param resources
* 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 #resources(List)
*/
Builder resources(Consumer... resources);
}
static final class BuilderImpl implements Builder {
private String value;
private String type;
private List resources = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(HandshakeResource model) {
value(model.value);
type(model.type);
resources(model.resources);
}
public final String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(HandshakeResourceType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final List getResources() {
List result = HandshakeResourcesCopier.copyToBuilder(this.resources);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setResources(Collection resources) {
this.resources = HandshakeResourcesCopier.copyFromBuilder(resources);
}
@Override
public final Builder resources(Collection resources) {
this.resources = HandshakeResourcesCopier.copy(resources);
return this;
}
@Override
@SafeVarargs
public final Builder resources(HandshakeResource... resources) {
resources(Arrays.asList(resources));
return this;
}
@Override
@SafeVarargs
public final Builder resources(Consumer... resources) {
resources(Stream.of(resources).map(c -> HandshakeResource.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public HandshakeResource build() {
return new HandshakeResource(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}