software.amazon.awssdk.services.kms.model.ReplicateKeyResponse Maven / Gradle / Ivy
Show all versions of kms 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.kms.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.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 ReplicateKeyResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField REPLICA_KEY_METADATA_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("ReplicaKeyMetadata")
.getter(getter(ReplicateKeyResponse::replicaKeyMetadata)).setter(setter(Builder::replicaKeyMetadata))
.constructor(KeyMetadata::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaKeyMetadata").build())
.build();
private static final SdkField REPLICA_POLICY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ReplicaPolicy").getter(getter(ReplicateKeyResponse::replicaPolicy))
.setter(setter(Builder::replicaPolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaPolicy").build()).build();
private static final SdkField> REPLICA_TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ReplicaTags")
.getter(getter(ReplicateKeyResponse::replicaTags))
.setter(setter(Builder::replicaTags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicaTags").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(REPLICA_KEY_METADATA_FIELD,
REPLICA_POLICY_FIELD, REPLICA_TAGS_FIELD));
private final KeyMetadata replicaKeyMetadata;
private final String replicaPolicy;
private final List replicaTags;
private ReplicateKeyResponse(BuilderImpl builder) {
super(builder);
this.replicaKeyMetadata = builder.replicaKeyMetadata;
this.replicaPolicy = builder.replicaPolicy;
this.replicaTags = builder.replicaTags;
}
/**
*
* Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It also
* includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
*
*
* @return Displays details about the new replica key, including its Amazon Resource Name (key ARN)
* and Key states of KMS
* keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica
* keys.
*/
public final KeyMetadata replicaKeyMetadata() {
return replicaKeyMetadata;
}
/**
*
* The key policy of the new replica key. The value is a key policy document in JSON format.
*
*
* @return The key policy of the new replica key. The value is a key policy document in JSON format.
*/
public final String replicaPolicy() {
return replicaPolicy;
}
/**
* For responses, this returns true if the service returned a value for the ReplicaTags 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 hasReplicaTags() {
return replicaTags != null && !(replicaTags instanceof SdkAutoConstructList);
}
/**
*
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
*
*
* 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 #hasReplicaTags} method.
*
*
* @return The tags on the new replica key. The value is a list of tag key and tag value pairs.
*/
public final List replicaTags() {
return replicaTags;
}
@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(replicaKeyMetadata());
hashCode = 31 * hashCode + Objects.hashCode(replicaPolicy());
hashCode = 31 * hashCode + Objects.hashCode(hasReplicaTags() ? replicaTags() : 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 ReplicateKeyResponse)) {
return false;
}
ReplicateKeyResponse other = (ReplicateKeyResponse) obj;
return Objects.equals(replicaKeyMetadata(), other.replicaKeyMetadata())
&& Objects.equals(replicaPolicy(), other.replicaPolicy()) && hasReplicaTags() == other.hasReplicaTags()
&& Objects.equals(replicaTags(), other.replicaTags());
}
/**
* 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("ReplicateKeyResponse").add("ReplicaKeyMetadata", replicaKeyMetadata())
.add("ReplicaPolicy", replicaPolicy()).add("ReplicaTags", hasReplicaTags() ? replicaTags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReplicaKeyMetadata":
return Optional.ofNullable(clazz.cast(replicaKeyMetadata()));
case "ReplicaPolicy":
return Optional.ofNullable(clazz.cast(replicaPolicy()));
case "ReplicaTags":
return Optional.ofNullable(clazz.cast(replicaTags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ReplicateKeyResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It
* also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
*
*
* @param replicaKeyMetadata
* Displays details about the new replica key, including its Amazon Resource Name (key ARN)
* and Key states of KMS
* keys. It also includes the ARN and Amazon Web Services Region of its primary key and other replica
* keys.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicaKeyMetadata(KeyMetadata replicaKeyMetadata);
/**
*
* Displays details about the new replica key, including its Amazon Resource Name (key ARN) and Key states of KMS keys. It
* also includes the ARN and Amazon Web Services Region of its primary key and other replica keys.
*
* This is a convenience method that creates an instance of the {@link KeyMetadata.Builder} avoiding the need to
* create one manually via {@link KeyMetadata#builder()}.
*
*
* When the {@link Consumer} completes, {@link KeyMetadata.Builder#build()} is called immediately and its result
* is passed to {@link #replicaKeyMetadata(KeyMetadata)}.
*
* @param replicaKeyMetadata
* a consumer that will call methods on {@link KeyMetadata.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #replicaKeyMetadata(KeyMetadata)
*/
default Builder replicaKeyMetadata(Consumer replicaKeyMetadata) {
return replicaKeyMetadata(KeyMetadata.builder().applyMutation(replicaKeyMetadata).build());
}
/**
*
* The key policy of the new replica key. The value is a key policy document in JSON format.
*
*
* @param replicaPolicy
* The key policy of the new replica key. The value is a key policy document in JSON format.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicaPolicy(String replicaPolicy);
/**
*
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
*
*
* @param replicaTags
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicaTags(Collection replicaTags);
/**
*
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
*
*
* @param replicaTags
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder replicaTags(Tag... replicaTags);
/**
*
* The tags on the new replica key. The value is a list of tag key and tag value pairs.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.kms.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.kms.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.kms.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #replicaTags(List)}.
*
* @param replicaTags
* a consumer that will call methods on {@link software.amazon.awssdk.services.kms.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #replicaTags(java.util.Collection)
*/
Builder replicaTags(Consumer... replicaTags);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private KeyMetadata replicaKeyMetadata;
private String replicaPolicy;
private List replicaTags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ReplicateKeyResponse model) {
super(model);
replicaKeyMetadata(model.replicaKeyMetadata);
replicaPolicy(model.replicaPolicy);
replicaTags(model.replicaTags);
}
public final KeyMetadata.Builder getReplicaKeyMetadata() {
return replicaKeyMetadata != null ? replicaKeyMetadata.toBuilder() : null;
}
public final void setReplicaKeyMetadata(KeyMetadata.BuilderImpl replicaKeyMetadata) {
this.replicaKeyMetadata = replicaKeyMetadata != null ? replicaKeyMetadata.build() : null;
}
@Override
public final Builder replicaKeyMetadata(KeyMetadata replicaKeyMetadata) {
this.replicaKeyMetadata = replicaKeyMetadata;
return this;
}
public final String getReplicaPolicy() {
return replicaPolicy;
}
public final void setReplicaPolicy(String replicaPolicy) {
this.replicaPolicy = replicaPolicy;
}
@Override
public final Builder replicaPolicy(String replicaPolicy) {
this.replicaPolicy = replicaPolicy;
return this;
}
public final List getReplicaTags() {
List result = TagListCopier.copyToBuilder(this.replicaTags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setReplicaTags(Collection replicaTags) {
this.replicaTags = TagListCopier.copyFromBuilder(replicaTags);
}
@Override
public final Builder replicaTags(Collection replicaTags) {
this.replicaTags = TagListCopier.copy(replicaTags);
return this;
}
@Override
@SafeVarargs
public final Builder replicaTags(Tag... replicaTags) {
replicaTags(Arrays.asList(replicaTags));
return this;
}
@Override
@SafeVarargs
public final Builder replicaTags(Consumer... replicaTags) {
replicaTags(Stream.of(replicaTags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ReplicateKeyResponse build() {
return new ReplicateKeyResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}