software.amazon.awssdk.services.kms.model.VerifyMacResponse 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.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
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 VerifyMacResponse extends KmsResponse implements
ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(VerifyMacResponse::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField MAC_VALID_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("MacValid").getter(getter(VerifyMacResponse::macValid)).setter(setter(Builder::macValid))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MacValid").build()).build();
private static final SdkField MAC_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MacAlgorithm").getter(getter(VerifyMacResponse::macAlgorithmAsString))
.setter(setter(Builder::macAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MacAlgorithm").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD, MAC_VALID_FIELD,
MAC_ALGORITHM_FIELD));
private final String keyId;
private final Boolean macValid;
private final String macAlgorithm;
private VerifyMacResponse(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.macValid = builder.macValid;
this.macAlgorithm = builder.macAlgorithm;
}
/**
*
* The HMAC KMS key used in the verification.
*
*
* @return The HMAC KMS key used in the verification.
*/
public final String keyId() {
return keyId;
}
/**
*
* A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the
* HMAC (Mac) was generated with the specified Message, HMAC KMS key (KeyID)
* and MacAlgorithm..
*
*
* If the HMAC is not verified, the VerifyMac operation fails with a
* KMSInvalidMacException exception. This exception indicates that one or more of the inputs changed
* since the HMAC was computed.
*
*
* @return A Boolean value that indicates whether the HMAC was verified. A value of True indicates that
* the HMAC (Mac) was generated with the specified Message, HMAC KMS key (
* KeyID) and MacAlgorithm..
*
* If the HMAC is not verified, the VerifyMac operation fails with a
* KMSInvalidMacException exception. This exception indicates that one or more of the inputs
* changed since the HMAC was computed.
*/
public final Boolean macValid() {
return macValid;
}
/**
*
* The MAC algorithm used in the verification.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #macAlgorithm} will
* return {@link MacAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #macAlgorithmAsString}.
*
*
* @return The MAC algorithm used in the verification.
* @see MacAlgorithmSpec
*/
public final MacAlgorithmSpec macAlgorithm() {
return MacAlgorithmSpec.fromValue(macAlgorithm);
}
/**
*
* The MAC algorithm used in the verification.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #macAlgorithm} will
* return {@link MacAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #macAlgorithmAsString}.
*
*
* @return The MAC algorithm used in the verification.
* @see MacAlgorithmSpec
*/
public final String macAlgorithmAsString() {
return macAlgorithm;
}
@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(keyId());
hashCode = 31 * hashCode + Objects.hashCode(macValid());
hashCode = 31 * hashCode + Objects.hashCode(macAlgorithmAsString());
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 VerifyMacResponse)) {
return false;
}
VerifyMacResponse other = (VerifyMacResponse) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(macValid(), other.macValid())
&& Objects.equals(macAlgorithmAsString(), other.macAlgorithmAsString());
}
/**
* 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("VerifyMacResponse").add("KeyId", keyId()).add("MacValid", macValid())
.add("MacAlgorithm", macAlgorithmAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "MacValid":
return Optional.ofNullable(clazz.cast(macValid()));
case "MacAlgorithm":
return Optional.ofNullable(clazz.cast(macAlgorithmAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((VerifyMacResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* The HMAC KMS key used in the verification.
*
*
* @param keyId
* The HMAC KMS key used in the verification.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* A Boolean value that indicates whether the HMAC was verified. A value of True indicates that the
* HMAC (Mac) was generated with the specified Message, HMAC KMS key (
* KeyID) and MacAlgorithm..
*
*
* If the HMAC is not verified, the VerifyMac operation fails with a
* KMSInvalidMacException exception. This exception indicates that one or more of the inputs
* changed since the HMAC was computed.
*
*
* @param macValid
* A Boolean value that indicates whether the HMAC was verified. A value of True indicates
* that the HMAC (Mac) was generated with the specified Message, HMAC KMS key (
* KeyID) and MacAlgorithm..
*
* If the HMAC is not verified, the VerifyMac operation fails with a
* KMSInvalidMacException exception. This exception indicates that one or more of the inputs
* changed since the HMAC was computed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder macValid(Boolean macValid);
/**
*
* The MAC algorithm used in the verification.
*
*
* @param macAlgorithm
* The MAC algorithm used in the verification.
* @see MacAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
Builder macAlgorithm(String macAlgorithm);
/**
*
* The MAC algorithm used in the verification.
*
*
* @param macAlgorithm
* The MAC algorithm used in the verification.
* @see MacAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see MacAlgorithmSpec
*/
Builder macAlgorithm(MacAlgorithmSpec macAlgorithm);
}
static final class BuilderImpl extends KmsResponse.BuilderImpl implements Builder {
private String keyId;
private Boolean macValid;
private String macAlgorithm;
private BuilderImpl() {
}
private BuilderImpl(VerifyMacResponse model) {
super(model);
keyId(model.keyId);
macValid(model.macValid);
macAlgorithm(model.macAlgorithm);
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final Boolean getMacValid() {
return macValid;
}
public final void setMacValid(Boolean macValid) {
this.macValid = macValid;
}
@Override
public final Builder macValid(Boolean macValid) {
this.macValid = macValid;
return this;
}
public final String getMacAlgorithm() {
return macAlgorithm;
}
public final void setMacAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
}
@Override
public final Builder macAlgorithm(String macAlgorithm) {
this.macAlgorithm = macAlgorithm;
return this;
}
@Override
public final Builder macAlgorithm(MacAlgorithmSpec macAlgorithm) {
this.macAlgorithm(macAlgorithm == null ? null : macAlgorithm.toString());
return this;
}
@Override
public VerifyMacResponse build() {
return new VerifyMacResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}