software.amazon.awssdk.services.cleanrooms.model.ProtectedQueryOutput Maven / Gradle / Ivy
Show all versions of cleanrooms 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.cleanrooms.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
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.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details about the protected query output.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ProtectedQueryOutput implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField S3_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("s3").getter(getter(ProtectedQueryOutput::s3))
.setter(setter(Builder::s3)).constructor(ProtectedQueryS3Output::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("s3").build()).build();
private static final SdkField> MEMBER_LIST_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("memberList")
.getter(getter(ProtectedQueryOutput::memberList))
.setter(setter(Builder::memberList))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("memberList").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ProtectedQuerySingleMemberOutput::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(S3_FIELD, MEMBER_LIST_FIELD));
private static final long serialVersionUID = 1L;
private final ProtectedQueryS3Output s3;
private final List memberList;
private final Type type;
private ProtectedQueryOutput(BuilderImpl builder) {
this.s3 = builder.s3;
this.memberList = builder.memberList;
this.type = builder.type;
}
/**
*
* If present, the output for a protected query with an `S3` output type.
*
*
* @return If present, the output for a protected query with an `S3` output type.
*/
public final ProtectedQueryS3Output s3() {
return s3;
}
/**
* For responses, this returns true if the service returned a value for the MemberList 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 hasMemberList() {
return memberList != null && !(memberList instanceof SdkAutoConstructList);
}
/**
*
* The list of member Amazon Web Services account(s) that received the results of the query.
*
*
* 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 #hasMemberList} method.
*
*
* @return The list of member Amazon Web Services account(s) that received the results of the query.
*/
public final List memberList() {
return memberList;
}
@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(s3());
hashCode = 31 * hashCode + Objects.hashCode(hasMemberList() ? memberList() : 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 ProtectedQueryOutput)) {
return false;
}
ProtectedQueryOutput other = (ProtectedQueryOutput) obj;
return Objects.equals(s3(), other.s3()) && hasMemberList() == other.hasMemberList()
&& Objects.equals(memberList(), other.memberList());
}
/**
* 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("ProtectedQueryOutput").add("S3", s3()).add("MemberList", hasMemberList() ? memberList() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "s3":
return Optional.ofNullable(clazz.cast(s3()));
case "memberList":
return Optional.ofNullable(clazz.cast(memberList()));
default:
return Optional.empty();
}
}
/**
* Create an instance of this class with {@link #s3()} initialized to the given value.
*
*
* If present, the output for a protected query with an `S3` output type.
*
*
* @param s3
* If present, the output for a protected query with an `S3` output type.
*/
public static ProtectedQueryOutput fromS3(ProtectedQueryS3Output s3) {
return builder().s3(s3).build();
}
/**
* Create an instance of this class with {@link #s3()} initialized to the given value.
*
*
* If present, the output for a protected query with an `S3` output type.
*
*
* @param s3
* If present, the output for a protected query with an `S3` output type.
*/
public static ProtectedQueryOutput fromS3(Consumer s3) {
ProtectedQueryS3Output.Builder builder = ProtectedQueryS3Output.builder();
s3.accept(builder);
return fromS3(builder.build());
}
/**
* Create an instance of this class with {@link #memberList()} initialized to the given value.
*
*
* The list of member Amazon Web Services account(s) that received the results of the query.
*
*
* @param memberList
* The list of member Amazon Web Services account(s) that received the results of the query.
*/
public static ProtectedQueryOutput fromMemberList(List memberList) {
return builder().memberList(memberList).build();
}
/**
* Retrieve an enum value representing which member of this object is populated.
*
* When this class is returned in a service response, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if the
* service returned a member that is only known to a newer SDK version.
*
* When this class is created directly in your code, this will be {@link Type#UNKNOWN_TO_SDK_VERSION} if zero
* members are set, and {@code null} if more than one member is set.
*/
public Type type() {
return type;
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ProtectedQueryOutput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* If present, the output for a protected query with an `S3` output type.
*
*
* @param s3
* If present, the output for a protected query with an `S3` output type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder s3(ProtectedQueryS3Output s3);
/**
*
* If present, the output for a protected query with an `S3` output type.
*
* This is a convenience method that creates an instance of the {@link ProtectedQueryS3Output.Builder} avoiding
* the need to create one manually via {@link ProtectedQueryS3Output#builder()}.
*
*
* When the {@link Consumer} completes, {@link ProtectedQueryS3Output.Builder#build()} is called immediately and
* its result is passed to {@link #s3(ProtectedQueryS3Output)}.
*
* @param s3
* a consumer that will call methods on {@link ProtectedQueryS3Output.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #s3(ProtectedQueryS3Output)
*/
default Builder s3(Consumer s3) {
return s3(ProtectedQueryS3Output.builder().applyMutation(s3).build());
}
/**
*
* The list of member Amazon Web Services account(s) that received the results of the query.
*
*
* @param memberList
* The list of member Amazon Web Services account(s) that received the results of the query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder memberList(Collection memberList);
/**
*
* The list of member Amazon Web Services account(s) that received the results of the query.
*
*
* @param memberList
* The list of member Amazon Web Services account(s) that received the results of the query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder memberList(ProtectedQuerySingleMemberOutput... memberList);
/**
*
* The list of member Amazon Web Services account(s) that received the results of the query.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.cleanrooms.model.ProtectedQuerySingleMemberOutput.Builder} avoiding
* the need to create one manually via
* {@link software.amazon.awssdk.services.cleanrooms.model.ProtectedQuerySingleMemberOutput#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.cleanrooms.model.ProtectedQuerySingleMemberOutput.Builder#build()} is
* called immediately and its result is passed to {@link #memberList(List)}.
*
* @param memberList
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.cleanrooms.model.ProtectedQuerySingleMemberOutput.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #memberList(java.util.Collection)
*/
Builder memberList(Consumer... memberList);
}
static final class BuilderImpl implements Builder {
private ProtectedQueryS3Output s3;
private List memberList = DefaultSdkAutoConstructList.getInstance();
private Type type = Type.UNKNOWN_TO_SDK_VERSION;
private Set setTypes = EnumSet.noneOf(Type.class);
private BuilderImpl() {
}
private BuilderImpl(ProtectedQueryOutput model) {
s3(model.s3);
memberList(model.memberList);
}
public final ProtectedQueryS3Output.Builder getS3() {
return s3 != null ? s3.toBuilder() : null;
}
public final void setS3(ProtectedQueryS3Output.BuilderImpl s3) {
Object oldValue = this.s3;
this.s3 = s3 != null ? s3.build() : null;
handleUnionValueChange(Type.S3, oldValue, this.s3);
}
@Override
public final Builder s3(ProtectedQueryS3Output s3) {
Object oldValue = this.s3;
this.s3 = s3;
handleUnionValueChange(Type.S3, oldValue, this.s3);
return this;
}
public final List getMemberList() {
List result = ProtectedQueryMemberOutputListCopier
.copyToBuilder(this.memberList);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setMemberList(Collection memberList) {
Object oldValue = this.memberList;
this.memberList = ProtectedQueryMemberOutputListCopier.copyFromBuilder(memberList);
handleUnionValueChange(Type.MEMBER_LIST, oldValue, this.memberList);
}
@Override
public final Builder memberList(Collection memberList) {
Object oldValue = this.memberList;
this.memberList = ProtectedQueryMemberOutputListCopier.copy(memberList);
handleUnionValueChange(Type.MEMBER_LIST, oldValue, this.memberList);
return this;
}
@Override
@SafeVarargs
public final Builder memberList(ProtectedQuerySingleMemberOutput... memberList) {
memberList(Arrays.asList(memberList));
return this;
}
@Override
@SafeVarargs
public final Builder memberList(Consumer... memberList) {
memberList(Stream.of(memberList).map(c -> ProtectedQuerySingleMemberOutput.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public ProtectedQueryOutput build() {
return new ProtectedQueryOutput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private final void handleUnionValueChange(Type type, Object oldValue, Object newValue) {
if (this.type == type || oldValue == newValue) {
return;
}
if (newValue == null || newValue instanceof SdkAutoConstructList || newValue instanceof SdkAutoConstructMap) {
setTypes.remove(type);
} else if (oldValue == null || oldValue instanceof SdkAutoConstructList || oldValue instanceof SdkAutoConstructMap) {
setTypes.add(type);
}
if (setTypes.size() == 1) {
this.type = setTypes.iterator().next();
} else if (setTypes.isEmpty()) {
this.type = Type.UNKNOWN_TO_SDK_VERSION;
} else {
this.type = null;
}
}
}
/**
* @see ProtectedQueryOutput#type()
*/
public enum Type {
S3,
MEMBER_LIST,
UNKNOWN_TO_SDK_VERSION
}
}