/*
* Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
* <p>
* Retrieves a list of policies attached to a key.
* </p>
*/
public class ListKeyPoliciesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
private String keyId;
/**
* <p>
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the <code>Truncated</code> element in the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1000<br/>
*/
private Integer limit;
/**
* <p>
* Use this parameter only when paginating results and only in a subsequent
* request after you receive a response with truncated results. Set it to
* the value of <code>NextMarker</code> from the response you just received.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 320<br/>
* <b>Pattern: </b>[ -\u00FF]*<br/>
*/
private String marker;
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return <p>
* A unique identifier for the customer master key. This value can
* be a globally unique identifier, a fully specified ARN to either
* an alias or a key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-
* 1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
*/
public String getKeyId() {
return keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier, a fully specified ARN to
* either an alias or a key, or an alias name prefixed by
* "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier, a fully specified ARN to either an alias or a
* key, or an alias name prefixed by "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example - arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier, a fully specified ARN to
* either an alias or a key, or an alias name prefixed by
* "alias/".
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias ARN Example -
* arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Alias Name Example - alias/MyAliasName
* </p>
* </li>
* </ul>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public ListKeyPoliciesRequest withKeyId(String keyId) {
this.keyId = keyId;
return this;
}
/**
* <p>
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the <code>Truncated</code> element in the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1000<br/>
*
* @return <p>
* When paginating results, specify the maximum number of items to
* return in the response. If additional items exist beyond the
* number you specify, the <code>Truncated</code> element in the
* response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
*/
public Integer getLimit() {
return limit;
}
/**
* <p>
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the <code>Truncated</code> element in the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1000<br/>
*
* @param limit <p>
* When paginating results, specify the maximum number of items
* to return in the response. If additional items exist beyond
* the number you specify, the <code>Truncated</code> element in
* the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
* <p>
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the <code>Truncated</code> element in the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Range: </b>1 - 1000<br/>
*
* @param limit <p>
* When paginating results, specify the maximum number of items
* to return in the response. If additional items exist beyond
* the number you specify, the <code>Truncated</code> element in
* the response is set to true.
* </p>
* <p>
* 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.
* </p>
* <p>
* Currently only 1 policy can be attached to a key.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public ListKeyPoliciesRequest withLimit(Integer limit) {
this.limit = limit;
return this;
}
/**
* <p>
* Use this parameter only when paginating results and only in a subsequent
* request after you receive a response with truncated results. Set it to
* the value of <code>NextMarker</code> from the response you just received.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 320<br/>
* <b>Pattern: </b>[ -\u00FF]*<br/>
*
* @return <p>
* Use this parameter only when paginating results and only in a
* subsequent request after you receive a response with truncated
* results. Set it to the value of <code>NextMarker</code> from the
* response you just received.
* </p>
*/
public String getMarker() {
return marker;
}
/**
* <p>
* Use this parameter only when paginating results and only in a subsequent
* request after you receive a response with truncated results. Set it to
* the value of <code>NextMarker</code> from the response you just received.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 320<br/>
* <b>Pattern: </b>[ -\u00FF]*<br/>
*
* @param marker <p>
* Use this parameter only when paginating results and only in a
* subsequent request after you receive a response with truncated
* results. Set it to the value of <code>NextMarker</code> from
* the response you just received.
* </p>
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
* <p>
* Use this parameter only when paginating results and only in a subsequent
* request after you receive a response with truncated results. Set it to
* the value of <code>NextMarker</code> from the response you just received.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 320<br/>
* <b>Pattern: </b>[ -\u00FF]*<br/>
*
* @param marker <p>
* Use this parameter only when paginating results and only in a
* subsequent request after you receive a response with truncated
* results. Set it to the value of <code>NextMarker</code> from
* the response you just received.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public ListKeyPoliciesRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @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: " + getKeyId() + ",");
if (getLimit() != null)
sb.append("Limit: " + getLimit() + ",");
if (getMarker() != null)
sb.append("Marker: " + getMarker());
sb.append("}");
return sb.toString();
}
@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 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;
}
}