
software.amazon.awssdk.services.secretsmanager.model.CreateSecretResponse 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.secretsmanager.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 CreateSecretResponse extends SecretsManagerResponse implements
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("ARN")
.getter(getter(CreateSecretResponse::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).memberName("Name")
.getter(getter(CreateSecretResponse::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField VERSION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VersionId").getter(getter(CreateSecretResponse::versionId)).setter(setter(Builder::versionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VersionId").build()).build();
private static final SdkField> REPLICATION_STATUS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ReplicationStatus")
.getter(getter(CreateSecretResponse::replicationStatus))
.setter(setter(Builder::replicationStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReplicationStatus").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ReplicationStatusType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, NAME_FIELD,
VERSION_ID_FIELD, REPLICATION_STATUS_FIELD));
private final String arn;
private final String name;
private final String versionId;
private final List replicationStatus;
private CreateSecretResponse(BuilderImpl builder) {
super(builder);
this.arn = builder.arn;
this.name = builder.name;
this.versionId = builder.versionId;
this.replicationStatus = builder.replicationStatus;
}
/**
*
* The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This
* ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old
* secret don't get access to the new secret because the ARNs are different.
*
*
* @return The ARN of the new secret. The ARN includes the name of the secret followed by six random characters.
* This ensures that if you create a new secret with the same name as a deleted secret, then users with
* access to the old secret don't get access to the new secret because the ARNs are different.
*/
public final String arn() {
return arn;
}
/**
*
* The name of the new secret.
*
*
* @return The name of the new secret.
*/
public final String name() {
return name;
}
/**
*
* The unique identifier associated with the version of the new secret.
*
*
* @return The unique identifier associated with the version of the new secret.
*/
public final String versionId() {
return versionId;
}
/**
* For responses, this returns true if the service returned a value for the ReplicationStatus 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 hasReplicationStatus() {
return replicationStatus != null && !(replicationStatus instanceof SdkAutoConstructList);
}
/**
*
* A list of the replicas of this secret and their status:
*
*
* -
*
* Failed
, which indicates that the replica was not created.
*
*
* -
*
* InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
*
*
* -
*
* InSync
, which indicates that the replica was created.
*
*
*
*
* 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 #hasReplicationStatus} method.
*
*
* @return A list of the replicas of this secret and their status:
*
* -
*
* Failed
, which indicates that the replica was not created.
*
*
* -
*
* InProgress
, which indicates that Secrets Manager is in the process of creating the replica.
*
*
* -
*
* InSync
, which indicates that the replica was created.
*
*
*/
public final List replicationStatus() {
return replicationStatus;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(versionId());
hashCode = 31 * hashCode + Objects.hashCode(hasReplicationStatus() ? replicationStatus() : 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 CreateSecretResponse)) {
return false;
}
CreateSecretResponse other = (CreateSecretResponse) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(versionId(), other.versionId()) && hasReplicationStatus() == other.hasReplicationStatus()
&& Objects.equals(replicationStatus(), other.replicationStatus());
}
/**
* 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("CreateSecretResponse").add("ARN", arn()).add("Name", name()).add("VersionId", versionId())
.add("ReplicationStatus", hasReplicationStatus() ? replicationStatus() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ARN":
return Optional.ofNullable(clazz.cast(arn()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "VersionId":
return Optional.ofNullable(clazz.cast(versionId()));
case "ReplicationStatus":
return Optional.ofNullable(clazz.cast(replicationStatus()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function