software.amazon.awssdk.services.qldb.model.GetRevisionRequest 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.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.awscore.AwsRequestOverrideConfiguration;
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 GetRevisionRequest extends QldbRequest implements
ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(GetRevisionRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("name").build()).build();
private static final SdkField BLOCK_ADDRESS_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("BlockAddress").getter(getter(GetRevisionRequest::blockAddress)).setter(setter(Builder::blockAddress))
.constructor(ValueHolder::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("BlockAddress").build()).build();
private static final SdkField DOCUMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DocumentId").getter(getter(GetRevisionRequest::documentId)).setter(setter(Builder::documentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DocumentId").build()).build();
private static final SdkField DIGEST_TIP_ADDRESS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("DigestTipAddress")
.getter(getter(GetRevisionRequest::digestTipAddress)).setter(setter(Builder::digestTipAddress))
.constructor(ValueHolder::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DigestTipAddress").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD,
BLOCK_ADDRESS_FIELD, DOCUMENT_ID_FIELD, DIGEST_TIP_ADDRESS_FIELD));
private final String name;
private final ValueHolder blockAddress;
private final String documentId;
private final ValueHolder digestTipAddress;
private GetRevisionRequest(BuilderImpl builder) {
super(builder);
this.name = builder.name;
this.blockAddress = builder.blockAddress;
this.documentId = builder.documentId;
this.digestTipAddress = builder.digestTipAddress;
}
/**
*
* The name of the ledger.
*
*
* @return The name of the ledger.
*/
public final String name() {
return name;
}
/**
*
* The block location of the document revision to be verified. An address is an Amazon Ion structure that has two
* fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
*
*
* @return The block location of the document revision to be verified. An address is an Amazon Ion structure that
* has two fields: strandId and sequenceNo.
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
*/
public final ValueHolder blockAddress() {
return blockAddress;
}
/**
*
* The UUID (represented in Base62-encoded text) of the document to be verified.
*
*
* @return The UUID (represented in Base62-encoded text) of the document to be verified.
*/
public final String documentId() {
return documentId;
}
/**
*
* The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
* structure that has two fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
*
*
* @return The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
* structure that has two fields: strandId and sequenceNo.
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
*/
public final ValueHolder digestTipAddress() {
return digestTipAddress;
}
@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(blockAddress());
hashCode = 31 * hashCode + Objects.hashCode(documentId());
hashCode = 31 * hashCode + Objects.hashCode(digestTipAddress());
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 GetRevisionRequest)) {
return false;
}
GetRevisionRequest other = (GetRevisionRequest) obj;
return Objects.equals(name(), other.name()) && Objects.equals(blockAddress(), other.blockAddress())
&& Objects.equals(documentId(), other.documentId())
&& Objects.equals(digestTipAddress(), other.digestTipAddress());
}
/**
* 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("GetRevisionRequest").add("Name", name())
.add("BlockAddress", blockAddress() == null ? null : "*** Sensitive Data Redacted ***")
.add("DocumentId", documentId())
.add("DigestTipAddress", digestTipAddress() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "BlockAddress":
return Optional.ofNullable(clazz.cast(blockAddress()));
case "DocumentId":
return Optional.ofNullable(clazz.cast(documentId()));
case "DigestTipAddress":
return Optional.ofNullable(clazz.cast(digestTipAddress()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetRevisionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends QldbRequest.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 block location of the document revision to be verified. An address is an Amazon Ion structure that has
* two fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
*
*
* @param blockAddress
* The block location of the document revision to be verified. An address is an Amazon Ion structure that
* has two fields: strandId and sequenceNo.
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder blockAddress(ValueHolder blockAddress);
/**
*
* The block location of the document revision to be verified. An address is an Amazon Ion structure that has
* two fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}.
*
* This is a convenience method that creates an instance of the {@link ValueHolder.Builder} avoiding the need to
* create one manually via {@link ValueHolder#builder()}.
*
*
* When the {@link Consumer} completes, {@link ValueHolder.Builder#build()} is called immediately and its result
* is passed to {@link #blockAddress(ValueHolder)}.
*
* @param blockAddress
* a consumer that will call methods on {@link ValueHolder.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #blockAddress(ValueHolder)
*/
default Builder blockAddress(Consumer blockAddress) {
return blockAddress(ValueHolder.builder().applyMutation(blockAddress).build());
}
/**
*
* The UUID (represented in Base62-encoded text) of the document to be verified.
*
*
* @param documentId
* The UUID (represented in Base62-encoded text) of the document to be verified.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder documentId(String documentId);
/**
*
* The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
* structure that has two fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
*
*
* @param digestTipAddress
* The latest block location covered by the digest for which to request a proof. An address is an Amazon
* Ion structure that has two fields: strandId and sequenceNo.
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder digestTipAddress(ValueHolder digestTipAddress);
/**
*
* The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion
* structure that has two fields: strandId and sequenceNo.
*
*
* For example: {strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}.
*
* This is a convenience method that creates an instance of the {@link ValueHolder.Builder} avoiding the need to
* create one manually via {@link ValueHolder#builder()}.
*
*
* When the {@link Consumer} completes, {@link ValueHolder.Builder#build()} is called immediately and its result
* is passed to {@link #digestTipAddress(ValueHolder)}.
*
* @param digestTipAddress
* a consumer that will call methods on {@link ValueHolder.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #digestTipAddress(ValueHolder)
*/
default Builder digestTipAddress(Consumer digestTipAddress) {
return digestTipAddress(ValueHolder.builder().applyMutation(digestTipAddress).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends QldbRequest.BuilderImpl implements Builder {
private String name;
private ValueHolder blockAddress;
private String documentId;
private ValueHolder digestTipAddress;
private BuilderImpl() {
}
private BuilderImpl(GetRevisionRequest model) {
super(model);
name(model.name);
blockAddress(model.blockAddress);
documentId(model.documentId);
digestTipAddress(model.digestTipAddress);
}
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 ValueHolder.Builder getBlockAddress() {
return blockAddress != null ? blockAddress.toBuilder() : null;
}
public final void setBlockAddress(ValueHolder.BuilderImpl blockAddress) {
this.blockAddress = blockAddress != null ? blockAddress.build() : null;
}
@Override
public final Builder blockAddress(ValueHolder blockAddress) {
this.blockAddress = blockAddress;
return this;
}
public final String getDocumentId() {
return documentId;
}
public final void setDocumentId(String documentId) {
this.documentId = documentId;
}
@Override
public final Builder documentId(String documentId) {
this.documentId = documentId;
return this;
}
public final ValueHolder.Builder getDigestTipAddress() {
return digestTipAddress != null ? digestTipAddress.toBuilder() : null;
}
public final void setDigestTipAddress(ValueHolder.BuilderImpl digestTipAddress) {
this.digestTipAddress = digestTipAddress != null ? digestTipAddress.build() : null;
}
@Override
public final Builder digestTipAddress(ValueHolder digestTipAddress) {
this.digestTipAddress = digestTipAddress;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetRevisionRequest build() {
return new GetRevisionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}