software.amazon.awssdk.services.kms.model.RetireGrantRequest 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.HashMap;
import java.util.List;
import java.util.Map;
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 RetireGrantRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField GRANT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GrantToken").getter(getter(RetireGrantRequest::grantToken)).setter(setter(Builder::grantToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantToken").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(RetireGrantRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField GRANT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GrantId").getter(getter(RetireGrantRequest::grantId)).setter(setter(Builder::grantId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantId").build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DryRun").getter(getter(RetireGrantRequest::dryRun)).setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GRANT_TOKEN_FIELD,
KEY_ID_FIELD, GRANT_ID_FIELD, DRY_RUN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String grantToken;
private final String keyId;
private final String grantId;
private final Boolean dryRun;
private RetireGrantRequest(BuilderImpl builder) {
super(builder);
this.grantToken = builder.grantToken;
this.keyId = builder.keyId;
this.grantId = builder.grantId;
this.dryRun = builder.dryRun;
}
/**
*
* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has achieved
* eventual consistency.
*
*
* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual
* consistency in the Key Management Service Developer Guide.
*
*
* @return Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has
* achieved eventual consistency.
*
* Only the CreateGrant operation returns a grant token. For details, see Grant token and
*
* Eventual consistency in the Key Management Service Developer Guide.
*/
public final String grantToken() {
return grantToken;
}
/**
*
* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
*
*
* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* @return The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys
* operation.
*
* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
*/
public final String keyId() {
return keyId;
}
/**
*
* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or
* ListRetirableGrants.
*
*
* -
*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*
* @return Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or
* ListRetirableGrants.
*
* -
*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
*
*
*/
public final String grantId() {
return grantId;
}
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @return Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*/
public final Boolean dryRun() {
return dryRun;
}
@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(grantToken());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(grantId());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
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 RetireGrantRequest)) {
return false;
}
RetireGrantRequest other = (RetireGrantRequest) obj;
return Objects.equals(grantToken(), other.grantToken()) && Objects.equals(keyId(), other.keyId())
&& Objects.equals(grantId(), other.grantId()) && Objects.equals(dryRun(), other.dryRun());
}
/**
* 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("RetireGrantRequest").add("GrantToken", grantToken()).add("KeyId", keyId())
.add("GrantId", grantId()).add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GrantToken":
return Optional.ofNullable(clazz.cast(grantToken()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "GrantId":
return Optional.ofNullable(clazz.cast(grantId()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("GrantToken", GRANT_TOKEN_FIELD);
map.put("KeyId", KEY_ID_FIELD);
map.put("GrantId", GRANT_ID_FIELD);
map.put("DryRun", DRY_RUN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((RetireGrantRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it has
* achieved eventual consistency.
*
*
* Only the CreateGrant operation returns a grant token. For details, see Grant token and Eventual
* consistency in the Key Management Service Developer Guide.
*
*
* @param grantToken
* Identifies the grant to be retired. You can use a grant token to identify a new grant even before it
* has achieved eventual consistency.
*
* Only the CreateGrant operation returns a grant token. For details, see Grant token
* and Eventual consistency in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantToken(String grantToken);
/**
*
* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys operation.
*
*
* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* @param keyId
* The key ARN KMS key associated with the grant. To find the key ARN, use the ListKeys
* operation.
*
* For example: arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or
* ListRetirableGrants.
*
*
* -
*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
*
*
*
*
* @param grantId
* Identifies the grant to retire. To get the grant ID, use CreateGrant, ListGrants, or
* ListRetirableGrants.
*
* -
*
* Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantId(String grantId);
/**
*
* Checks if your request will succeed. DryRun is an optional parameter.
*
*
* To learn more about how to use this parameter, see Testing your KMS API
* calls in the Key Management Service Developer Guide.
*
*
* @param dryRun
* Checks if your request will succeed. DryRun is an optional parameter.
*
* To learn more about how to use this parameter, see Testing your KMS
* API calls in the Key Management Service Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String grantToken;
private String keyId;
private String grantId;
private Boolean dryRun;
private BuilderImpl() {
}
private BuilderImpl(RetireGrantRequest model) {
super(model);
grantToken(model.grantToken);
keyId(model.keyId);
grantId(model.grantId);
dryRun(model.dryRun);
}
public final String getGrantToken() {
return grantToken;
}
public final void setGrantToken(String grantToken) {
this.grantToken = grantToken;
}
@Override
public final Builder grantToken(String grantToken) {
this.grantToken = grantToken;
return this;
}
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 String getGrantId() {
return grantId;
}
public final void setGrantId(String grantId) {
this.grantId = grantId;
}
@Override
public final Builder grantId(String grantId) {
this.grantId = grantId;
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
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 RetireGrantRequest build() {
return new RetireGrantRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}