software.amazon.awssdk.services.qldb.model.DescribeLedgerResponse Maven / Gradle / Ivy
Show all versions of qldb 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.qldb.model;
import java.time.Instant;
import java.util.Arrays;
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 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.LocationTrait;
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 DescribeLedgerResponse extends QldbResponse implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(DescribeLedgerResponse::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(DescribeLedgerResponse::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField STATE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("State")
.getter(getter(DescribeLedgerResponse::stateAsString)).setter(setter(Builder::state))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("State").build()).build();
private static final SdkField CREATION_DATE_TIME_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreationDateTime").getter(getter(DescribeLedgerResponse::creationDateTime))
.setter(setter(Builder::creationDateTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreationDateTime").build()).build();
private static final SdkField PERMISSIONS_MODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PermissionsMode").getter(getter(DescribeLedgerResponse::permissionsModeAsString))
.setter(setter(Builder::permissionsMode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PermissionsMode").build()).build();
private static final SdkField DELETION_PROTECTION_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DeletionProtection").getter(getter(DescribeLedgerResponse::deletionProtection))
.setter(setter(Builder::deletionProtection))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeletionProtection").build())
.build();
private static final SdkField ENCRYPTION_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("EncryptionDescription")
.getter(getter(DescribeLedgerResponse::encryptionDescription)).setter(setter(Builder::encryptionDescription))
.constructor(LedgerEncryptionDescription::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EncryptionDescription").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, ARN_FIELD,
STATE_FIELD, CREATION_DATE_TIME_FIELD, PERMISSIONS_MODE_FIELD, DELETION_PROTECTION_FIELD,
ENCRYPTION_DESCRIPTION_FIELD));
private final String name;
private final String arn;
private final String state;
private final Instant creationDateTime;
private final String permissionsMode;
private final Boolean deletionProtection;
private final LedgerEncryptionDescription encryptionDescription;
private DescribeLedgerResponse(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.arn = builder.arn;
this.state = builder.state;
this.creationDateTime = builder.creationDateTime;
this.permissionsMode = builder.permissionsMode;
this.deletionProtection = builder.deletionProtection;
this.encryptionDescription = builder.encryptionDescription;
}
/**
*
* The name of the ledger.
*
*
* @return The name of the ledger.
*/
public final String name() {
return name;
}
/**
*
* The Amazon Resource Name (ARN) for the ledger.
*
*
* @return The Amazon Resource Name (ARN) for the ledger.
*/
public final String arn() {
return arn;
}
/**
*
* The current status of the ledger.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link LedgerState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current status of the ledger.
* @see LedgerState
*/
public final LedgerState state() {
return LedgerState.fromValue(state);
}
/**
*
* The current status of the ledger.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #state} will return
* {@link LedgerState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateAsString}.
*
*
* @return The current status of the ledger.
* @see LedgerState
*/
public final String stateAsString() {
return state;
}
/**
*
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds
* elapsed since 12:00:00 AM January 1, 1970 UTC.)
*
*
* @return The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of
* seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*/
public final Instant creationDateTime() {
return creationDateTime;
}
/**
*
* The permissions mode of the ledger.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #permissionsMode}
* will return {@link PermissionsMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #permissionsModeAsString}.
*
*
* @return The permissions mode of the ledger.
* @see PermissionsMode
*/
public final PermissionsMode permissionsMode() {
return PermissionsMode.fromValue(permissionsMode);
}
/**
*
* The permissions mode of the ledger.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #permissionsMode}
* will return {@link PermissionsMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #permissionsModeAsString}.
*
*
* @return The permissions mode of the ledger.
* @see PermissionsMode
*/
public final String permissionsModeAsString() {
return permissionsMode;
}
/**
*
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation,
* this feature is enabled (true) by default.
*
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it
* by calling the UpdateLedger operation to set this parameter to false.
*
*
* @return Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to false.
*/
public final Boolean deletionProtection() {
return deletionProtection;
}
/**
*
* Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key,
* and when the key became inaccessible (in the case of an error).
*
*
* @return Information about the encryption of data at rest in the ledger. This includes the current status, the KMS
* key, and when the key became inaccessible (in the case of an error).
*/
public final LedgerEncryptionDescription encryptionDescription() {
return encryptionDescription;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(arn());
hashCode = 31 * hashCode + Objects.hashCode(stateAsString());
hashCode = 31 * hashCode + Objects.hashCode(creationDateTime());
hashCode = 31 * hashCode + Objects.hashCode(permissionsModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(deletionProtection());
hashCode = 31 * hashCode + Objects.hashCode(encryptionDescription());
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 DescribeLedgerResponse)) {
return false;
}
DescribeLedgerResponse other = (DescribeLedgerResponse) obj;
return Objects.equals(name(), other.name()) && Objects.equals(arn(), other.arn())
&& Objects.equals(stateAsString(), other.stateAsString())
&& Objects.equals(creationDateTime(), other.creationDateTime())
&& Objects.equals(permissionsModeAsString(), other.permissionsModeAsString())
&& Objects.equals(deletionProtection(), other.deletionProtection())
&& Objects.equals(encryptionDescription(), other.encryptionDescription());
}
/**
* 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("DescribeLedgerResponse").add("Name", name()).add("Arn", arn()).add("State", stateAsString())
.add("CreationDateTime", creationDateTime()).add("PermissionsMode", permissionsModeAsString())
.add("DeletionProtection", deletionProtection()).add("EncryptionDescription", encryptionDescription()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "State":
return Optional.ofNullable(clazz.cast(stateAsString()));
case "CreationDateTime":
return Optional.ofNullable(clazz.cast(creationDateTime()));
case "PermissionsMode":
return Optional.ofNullable(clazz.cast(permissionsModeAsString()));
case "DeletionProtection":
return Optional.ofNullable(clazz.cast(deletionProtection()));
case "EncryptionDescription":
return Optional.ofNullable(clazz.cast(encryptionDescription()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeLedgerResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QldbResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the ledger.
*
*
* @param name
* The name of the ledger.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The Amazon Resource Name (ARN) for the ledger.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the ledger.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* The current status of the ledger.
*
*
* @param state
* The current status of the ledger.
* @see LedgerState
* @return Returns a reference to this object so that method calls can be chained together.
* @see LedgerState
*/
Builder state(String state);
/**
*
* The current status of the ledger.
*
*
* @param state
* The current status of the ledger.
* @see LedgerState
* @return Returns a reference to this object so that method calls can be chained together.
* @see LedgerState
*/
Builder state(LedgerState state);
/**
*
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of
* seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
*
*
* @param creationDateTime
* The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number
* of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder creationDateTime(Instant creationDateTime);
/**
*
* The permissions mode of the ledger.
*
*
* @param permissionsMode
* The permissions mode of the ledger.
* @see PermissionsMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionsMode
*/
Builder permissionsMode(String permissionsMode);
/**
*
* The permissions mode of the ledger.
*
*
* @param permissionsMode
* The permissions mode of the ledger.
* @see PermissionsMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see PermissionsMode
*/
Builder permissionsMode(PermissionsMode permissionsMode);
/**
*
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to false.
*
*
* @param deletionProtection
* Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger
* creation, this feature is enabled (true) by default.
*
* If deletion protection is enabled, you must first disable it before you can delete the ledger. You can
* disable it by calling the UpdateLedger operation to set this parameter to
* false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deletionProtection(Boolean deletionProtection);
/**
*
* Information about the encryption of data at rest in the ledger. This includes the current status, the KMS
* key, and when the key became inaccessible (in the case of an error).
*
*
* @param encryptionDescription
* Information about the encryption of data at rest in the ledger. This includes the current status, the
* KMS key, and when the key became inaccessible (in the case of an error).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryptionDescription(LedgerEncryptionDescription encryptionDescription);
/**
*
* Information about the encryption of data at rest in the ledger. This includes the current status, the KMS
* key, and when the key became inaccessible (in the case of an error).
*
* This is a convenience method that creates an instance of the {@link LedgerEncryptionDescription.Builder}
* avoiding the need to create one manually via {@link LedgerEncryptionDescription#builder()}.
*
*
* When the {@link Consumer} completes, {@link LedgerEncryptionDescription.Builder#build()} is called
* immediately and its result is passed to {@link #encryptionDescription(LedgerEncryptionDescription)}.
*
* @param encryptionDescription
* a consumer that will call methods on {@link LedgerEncryptionDescription.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #encryptionDescription(LedgerEncryptionDescription)
*/
default Builder encryptionDescription(Consumer encryptionDescription) {
return encryptionDescription(LedgerEncryptionDescription.builder().applyMutation(encryptionDescription).build());
}
}
static final class BuilderImpl extends QldbResponse.BuilderImpl implements Builder {
private String name;
private String arn;
private String state;
private Instant creationDateTime;
private String permissionsMode;
private Boolean deletionProtection;
private LedgerEncryptionDescription encryptionDescription;
private BuilderImpl() {
}
private BuilderImpl(DescribeLedgerResponse model) {
super(model);
name(model.name);
arn(model.arn);
state(model.state);
creationDateTime(model.creationDateTime);
permissionsMode(model.permissionsMode);
deletionProtection(model.deletionProtection);
encryptionDescription(model.encryptionDescription);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final String getState() {
return state;
}
public final void setState(String state) {
this.state = state;
}
@Override
public final Builder state(String state) {
this.state = state;
return this;
}
@Override
public final Builder state(LedgerState state) {
this.state(state == null ? null : state.toString());
return this;
}
public final Instant getCreationDateTime() {
return creationDateTime;
}
public final void setCreationDateTime(Instant creationDateTime) {
this.creationDateTime = creationDateTime;
}
@Override
public final Builder creationDateTime(Instant creationDateTime) {
this.creationDateTime = creationDateTime;
return this;
}
public final String getPermissionsMode() {
return permissionsMode;
}
public final void setPermissionsMode(String permissionsMode) {
this.permissionsMode = permissionsMode;
}
@Override
public final Builder permissionsMode(String permissionsMode) {
this.permissionsMode = permissionsMode;
return this;
}
@Override
public final Builder permissionsMode(PermissionsMode permissionsMode) {
this.permissionsMode(permissionsMode == null ? null : permissionsMode.toString());
return this;
}
public final Boolean getDeletionProtection() {
return deletionProtection;
}
public final void setDeletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
}
@Override
public final Builder deletionProtection(Boolean deletionProtection) {
this.deletionProtection = deletionProtection;
return this;
}
public final LedgerEncryptionDescription.Builder getEncryptionDescription() {
return encryptionDescription != null ? encryptionDescription.toBuilder() : null;
}
public final void setEncryptionDescription(LedgerEncryptionDescription.BuilderImpl encryptionDescription) {
this.encryptionDescription = encryptionDescription != null ? encryptionDescription.build() : null;
}
@Override
public final Builder encryptionDescription(LedgerEncryptionDescription encryptionDescription) {
this.encryptionDescription = encryptionDescription;
return this;
}
@Override
public DescribeLedgerResponse build() {
return new DescribeLedgerResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}