software.amazon.awssdk.services.kms.model.ListGrantsRequest 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.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 ListGrantsRequest extends KmsRequest implements
ToCopyableBuilder {
private static final SdkField LIMIT_FIELD = SdkField. builder(MarshallingType.INTEGER).memberName("Limit")
.getter(getter(ListGrantsRequest::limit)).setter(setter(Builder::limit))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Limit").build()).build();
private static final SdkField MARKER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Marker")
.getter(getter(ListGrantsRequest::marker)).setter(setter(Builder::marker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Marker").build()).build();
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(ListGrantsRequest::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(ListGrantsRequest::grantId)).setter(setter(Builder::grantId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantId").build()).build();
private static final SdkField GRANTEE_PRINCIPAL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GranteePrincipal").getter(getter(ListGrantsRequest::granteePrincipal))
.setter(setter(Builder::granteePrincipal))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GranteePrincipal").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LIMIT_FIELD, MARKER_FIELD,
KEY_ID_FIELD, GRANT_ID_FIELD, GRANTEE_PRINCIPAL_FIELD));
private final Integer limit;
private final String marker;
private final String keyId;
private final String grantId;
private final String granteePrincipal;
private ListGrantsRequest(BuilderImpl builder) {
super(builder);
this.limit = builder.limit;
this.marker = builder.marker;
this.keyId = builder.keyId;
this.grantId = builder.grantId;
this.granteePrincipal = builder.granteePrincipal;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does not
* return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a
* value, it defaults to 50.
*
*
* @return Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS
* does not return more than the specified number of items, but it might return fewer.
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
*/
public final Integer limit() {
return limit;
}
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextMarker from the truncated response you just received.
*
*
* @return Use this parameter in a subsequent request after you receive a response with truncated results. Set it to
* the value of NextMarker from the truncated response you just received.
*/
public final String marker() {
return marker;
}
/**
*
* Returns only grants for the specified customer master key (CMK). This parameter is required.
*
*
* Specify the key ID or key ARN of the CMK. To specify a CMK in a different AWS account, you must use the key ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
*
*
* @return Returns only grants for the specified customer master key (CMK). This parameter is required.
*
* Specify the key ID or key ARN of the CMK. To specify a CMK in a different AWS account, you must use the
* key ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
*/
public final String keyId() {
return keyId;
}
/**
*
* Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
*
*
* @return Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
*/
public final String grantId() {
return grantId;
}
/**
*
* Returns only grants where the specified principal is the grantee principal for the grant.
*
*
* @return Returns only grants where the specified principal is the grantee principal for the grant.
*/
public final String granteePrincipal() {
return granteePrincipal;
}
@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(limit());
hashCode = 31 * hashCode + Objects.hashCode(marker());
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(grantId());
hashCode = 31 * hashCode + Objects.hashCode(granteePrincipal());
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 ListGrantsRequest)) {
return false;
}
ListGrantsRequest other = (ListGrantsRequest) obj;
return Objects.equals(limit(), other.limit()) && Objects.equals(marker(), other.marker())
&& Objects.equals(keyId(), other.keyId()) && Objects.equals(grantId(), other.grantId())
&& Objects.equals(granteePrincipal(), other.granteePrincipal());
}
/**
* 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("ListGrantsRequest").add("Limit", limit()).add("Marker", marker()).add("KeyId", keyId())
.add("GrantId", grantId()).add("GranteePrincipal", granteePrincipal()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Limit":
return Optional.ofNullable(clazz.cast(limit()));
case "Marker":
return Optional.ofNullable(clazz.cast(marker()));
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "GrantId":
return Optional.ofNullable(clazz.cast(grantId()));
case "GranteePrincipal":
return Optional.ofNullable(clazz.cast(granteePrincipal()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListGrantsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, AWS KMS does
* not return more than the specified number of items, but it might return fewer.
*
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
*
*
* @param limit
* Use this parameter to specify the maximum number of items to return. When this value is present, AWS
* KMS does not return more than the specified number of items, but it might return fewer.
*
* This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not
* include a value, it defaults to 50.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder limit(Integer limit);
/**
*
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the
* value of NextMarker from the truncated response you just received.
*
*
* @param marker
* Use this parameter in a subsequent request after you receive a response with truncated results. Set it
* to the value of NextMarker from the truncated response you just received.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder marker(String marker);
/**
*
* Returns only grants for the specified customer master key (CMK). This parameter is required.
*
*
* Specify the key ID or key ARN of the CMK. To specify a CMK in a different AWS account, you must use the key
* ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
*
*
* @param keyId
* Returns only grants for the specified customer master key (CMK). This parameter is required.
*
* Specify the key ID or key ARN of the CMK. To specify a CMK in a different AWS account, you must use
* the key ARN.
*
*
* For example:
*
*
* -
*
* Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
*
*
* -
*
* Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
*
*
*
*
* To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
*
*
* @param grantId
* Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantId(String grantId);
/**
*
* Returns only grants where the specified principal is the grantee principal for the grant.
*
*
* @param granteePrincipal
* Returns only grants where the specified principal is the grantee principal for the grant.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder granteePrincipal(String granteePrincipal);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private Integer limit;
private String marker;
private String keyId;
private String grantId;
private String granteePrincipal;
private BuilderImpl() {
}
private BuilderImpl(ListGrantsRequest model) {
super(model);
limit(model.limit);
marker(model.marker);
keyId(model.keyId);
grantId(model.grantId);
granteePrincipal(model.granteePrincipal);
}
public final Integer getLimit() {
return limit;
}
@Override
public final Builder limit(Integer limit) {
this.limit = limit;
return this;
}
public final void setLimit(Integer limit) {
this.limit = limit;
}
public final String getMarker() {
return marker;
}
@Override
public final Builder marker(String marker) {
this.marker = marker;
return this;
}
public final void setMarker(String marker) {
this.marker = marker;
}
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 getGrantId() {
return grantId;
}
@Override
public final Builder grantId(String grantId) {
this.grantId = grantId;
return this;
}
public final void setGrantId(String grantId) {
this.grantId = grantId;
}
public final String getGranteePrincipal() {
return granteePrincipal;
}
@Override
public final Builder granteePrincipal(String granteePrincipal) {
this.granteePrincipal = granteePrincipal;
return this;
}
public final void setGranteePrincipal(String granteePrincipal) {
this.granteePrincipal = granteePrincipal;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListGrantsRequest build() {
return new ListGrantsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}