com.ibm.cloud.objectstorage.services.kms.model.ListKeyPoliciesRequest Maven / Gradle / Ivy
Show all versions of ibm-cos-java-sdk-bundle Show documentation
/*
* Copyright 2017-2022 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.ibm.cloud.objectstorage.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.ibm.cloud.objectstorage.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListKeyPoliciesRequest extends com.ibm.cloud.objectstorage.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Gets the names of key policies for the specified KMS key.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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;
/**
*
* 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 1000, inclusive. If you do not include a
* value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*
*/
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;
/**
*
* Gets the names of key policies for the specified KMS key.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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
* Gets the names of key policies for the specified KMS key.
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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;
}
/**
*
* Gets the names of key policies for the specified KMS key.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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 Gets the names of key policies for the specified KMS key.
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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;
}
/**
*
* Gets the names of key policies for the specified KMS key.
*
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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
* Gets the names of key policies for the specified KMS key.
*
* Specify the key ID or key ARN of the KMS key.
*
*
* 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 ListKeyPoliciesRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* 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 1000, inclusive. If you do not include a
* value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*
*
* @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 1000, inclusive. If you do not
* include a value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*/
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 1000, inclusive. If you do not include a
* value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*
*
* @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 1000, inclusive. If you do not
* include a value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*/
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 1000, inclusive. If you do not include a
* value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
*
*
* @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 1000, inclusive. If you do not
* include a value, it defaults to 100.
*
*
* Only one policy can be attached to a key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListKeyPoliciesRequest 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 ListKeyPoliciesRequest withMarker(String marker) {
setMarker(marker);
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 (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getMarker() != null)
sb.append("Marker: ").append(getMarker());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListKeyPoliciesRequest == false)
return false;
ListKeyPoliciesRequest other = (ListKeyPoliciesRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
return hashCode;
}
@Override
public ListKeyPoliciesRequest clone() {
return (ListKeyPoliciesRequest) super.clone();
}
}