com.amazonaws.services.kms.model.ListGrantsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListGrantsRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, 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.
*
*/
private 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.
*
*/
private String marker;
/**
*
* Returns only grants for the specified KMS key. This parameter is required.
*
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
*
*/
private String keyId;
/**
*
* Returns only the grant with the specified grant ID. The grant ID uniquely identifies the grant.
*
*/
private String grantId;
/**
*
* Returns only grants where the specified principal is the grantee principal for the grant.
*
*/
private String granteePrincipal;
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, 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, 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 void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, 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, 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 Integer getLimit() {
return this.limit;
}
/**
*
* Use this parameter to specify the maximum number of items to return. When this value is present, 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, 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.
*/
public ListGrantsRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* 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.
*/
public void setMarker(String marker) {
this.marker = 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 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 String getMarker() {
return this.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.
*
*
* @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.
*/
public ListGrantsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* Returns only grants for the specified KMS key. This parameter is required.
*
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
*
*
* @param keyId
* Returns only grants for the specified KMS key. This parameter is required.
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services
* 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 KMS key, use ListKeys or DescribeKey.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* Returns only grants for the specified KMS key. This parameter is required.
*
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
*
*
* @return Returns only grants for the specified KMS key. This parameter is required.
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services
* 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 KMS key, use ListKeys or DescribeKey.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* Returns only grants for the specified KMS key. This parameter is required.
*
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.
*
*
* @param keyId
* Returns only grants for the specified KMS key. This parameter is required.
*
* Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services
* 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 KMS key, use ListKeys or DescribeKey.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListGrantsRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* 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.
*/
public void setGrantId(String grantId) {
this.grantId = grantId;
}
/**
*
* 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 String getGrantId() {
return this.grantId;
}
/**
*
* 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.
*/
public ListGrantsRequest withGrantId(String grantId) {
setGrantId(grantId);
return this;
}
/**
*
* 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.
*/
public void setGranteePrincipal(String granteePrincipal) {
this.granteePrincipal = granteePrincipal;
}
/**
*
* 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 String getGranteePrincipal() {
return this.granteePrincipal;
}
/**
*
* 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.
*/
public ListGrantsRequest withGranteePrincipal(String granteePrincipal) {
setGranteePrincipal(granteePrincipal);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker()).append(",");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getGrantId() != null)
sb.append("GrantId: ").append(getGrantId()).append(",");
if (getGranteePrincipal() != null)
sb.append("GranteePrincipal: ").append(getGranteePrincipal());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListGrantsRequest == false)
return false;
ListGrantsRequest other = (ListGrantsRequest) obj;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == false)
return false;
if (other.getMarker() == null ^ this.getMarker() == null)
return false;
if (other.getMarker() != null && other.getMarker().equals(this.getMarker()) == false)
return false;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getGrantId() == null ^ this.getGrantId() == null)
return false;
if (other.getGrantId() != null && other.getGrantId().equals(this.getGrantId()) == false)
return false;
if (other.getGranteePrincipal() == null ^ this.getGranteePrincipal() == null)
return false;
if (other.getGranteePrincipal() != null && other.getGranteePrincipal().equals(this.getGranteePrincipal()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getGrantId() == null) ? 0 : getGrantId().hashCode());
hashCode = prime * hashCode + ((getGranteePrincipal() == null) ? 0 : getGranteePrincipal().hashCode());
return hashCode;
}
@Override
public ListGrantsRequest clone() {
return (ListGrantsRequest) super.clone();
}
}