software.amazon.awssdk.services.xray.model.PutEncryptionConfigRequest 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.xray.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 PutEncryptionConfigRequest extends XRayRequest implements
ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutEncryptionConfigRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(PutEncryptionConfigRequest::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD, TYPE_FIELD));
private final String keyId;
private final String type;
private PutEncryptionConfigRequest(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.type = builder.type;
}
/**
*
* An AWS KMS customer master key (CMK) in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS
* X-Ray does not support asymmetric CMKs.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*
* @return An AWS KMS customer master key (CMK) in one of the following formats:
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example,
* ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this
* format to specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*/
public String keyId() {
return keyId;
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link EncryptionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
*/
public EncryptionType type() {
return EncryptionType.fromValue(type);
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link EncryptionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
*/
public String typeAsString() {
return type;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PutEncryptionConfigRequest)) {
return false;
}
PutEncryptionConfigRequest other = (PutEncryptionConfigRequest) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(typeAsString(), other.typeAsString());
}
/**
* 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 String toString() {
return ToString.builder("PutEncryptionConfigRequest").add("KeyId", keyId()).add("Type", typeAsString()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PutEncryptionConfigRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends XRayRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* An AWS KMS customer master key (CMK) in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
* AWS X-Ray does not support asymmetric CMKs.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*
* @param keyId
* An AWS KMS customer master key (CMK) in one of the following formats:
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example,
* ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. AWS X-Ray does not support asymmetric CMKs.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this
* format to specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE
* for default encryption.
*
*
* @param type
* The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
Builder type(String type);
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE
* for default encryption.
*
*
* @param type
* The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
Builder type(EncryptionType type);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends XRayRequest.BuilderImpl implements Builder {
private String keyId;
private String type;
private BuilderImpl() {
}
private BuilderImpl(PutEncryptionConfigRequest model) {
super(model);
keyId(model.keyId);
type(model.type);
}
public final String getKeyId() {
return keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
public final String getTypeAsString() {
return type;
}
@Override
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
public final Builder type(EncryptionType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final void setType(String type) {
this.type = type;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutEncryptionConfigRequest build() {
return new PutEncryptionConfigRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}