com.amazonaws.services.kms.model.ListRetirableGrantsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2011-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;
/**
*
*/
public class ListRetirableGrantsRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the Truncated element in the response is set to true.
*
*
* 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 only when paginating results and only in a subsequent
* request after you receive a response with truncated results. Set it to
* the value of NextMarker from the response you just received.
*
*/
private String marker;
/**
*
* The retiring principal for which to list grants.
*
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals
* include AWS accounts (root), IAM users, federated users, and assumed role
* users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section
* of the Amazon Web Services General Reference.
*
*/
private String retiringPrincipal;
/**
*
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the Truncated element in the response is set to true.
*
*
* 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
* When paginating results, specify the maximum number of items to
* return in the response. If additional items exist beyond the
* number you specify, the Truncated element in the
* response is set to true.
*
* 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;
}
/**
*
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the Truncated element in the response is set to true.
*
*
* 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 When paginating results, specify the maximum number of items to
* return in the response. If additional items exist beyond the
* number you specify, the Truncated element in the
* response is set to true.
*
* 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;
}
/**
*
* When paginating results, specify the maximum number of items to return in
* the response. If additional items exist beyond the number you specify,
* the Truncated element in the response is set to true.
*
*
* 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
* When paginating results, specify the maximum number of items to
* return in the response. If additional items exist beyond the
* number you specify, the Truncated element in the
* response is set to true.
*
* 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 ListRetirableGrantsRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* 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 NextMarker from the response you just received.
*
*
* @param marker
* 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 NextMarker from the
* response you just received.
*/
public void setMarker(String marker) {
this.marker = marker;
}
/**
*
* 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 NextMarker from the response you just received.
*
*
* @return 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 NextMarker from the
* response you just received.
*/
public String getMarker() {
return this.marker;
}
/**
*
* 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 NextMarker from the response you just received.
*
*
* @param marker
* 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 NextMarker from the
* response you just received.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListRetirableGrantsRequest withMarker(String marker) {
setMarker(marker);
return this;
}
/**
*
* The retiring principal for which to list grants.
*
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals
* include AWS accounts (root), IAM users, federated users, and assumed role
* users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section
* of the Amazon Web Services General Reference.
*
*
* @param retiringPrincipal
* The retiring principal for which to list grants.
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS
* principals include AWS accounts (root), IAM users, federated
* users, and assumed role users. For examples of the ARN syntax for
* specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs
* section of the Amazon Web Services General Reference.
*/
public void setRetiringPrincipal(String retiringPrincipal) {
this.retiringPrincipal = retiringPrincipal;
}
/**
*
* The retiring principal for which to list grants.
*
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals
* include AWS accounts (root), IAM users, federated users, and assumed role
* users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section
* of the Amazon Web Services General Reference.
*
*
* @return The retiring principal for which to list grants.
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS
* principals include AWS accounts (root), IAM users, federated
* users, and assumed role users. For examples of the ARN syntax for
* specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs
* section of the Amazon Web Services General Reference.
*/
public String getRetiringPrincipal() {
return this.retiringPrincipal;
}
/**
*
* The retiring principal for which to list grants.
*
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS principals
* include AWS accounts (root), IAM users, federated users, and assumed role
* users. For examples of the ARN syntax for specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs section
* of the Amazon Web Services General Reference.
*
*
* @param retiringPrincipal
* The retiring principal for which to list grants.
*
* To specify the retiring principal, use the Amazon Resource Name (ARN) of an AWS principal. Valid AWS
* principals include AWS accounts (root), IAM users, federated
* users, and assumed role users. For examples of the ARN syntax for
* specifying a principal, see AWS Identity and Access Management (IAM) in the Example ARNs
* section of the Amazon Web Services General Reference.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public ListRetirableGrantsRequest withRetiringPrincipal(
String retiringPrincipal) {
setRetiringPrincipal(retiringPrincipal);
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 (getLimit() != null)
sb.append("Limit: " + getLimit() + ",");
if (getMarker() != null)
sb.append("Marker: " + getMarker() + ",");
if (getRetiringPrincipal() != null)
sb.append("RetiringPrincipal: " + getRetiringPrincipal());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListRetirableGrantsRequest == false)
return false;
ListRetirableGrantsRequest other = (ListRetirableGrantsRequest) 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.getRetiringPrincipal() == null
^ this.getRetiringPrincipal() == null)
return false;
if (other.getRetiringPrincipal() != null
&& other.getRetiringPrincipal().equals(
this.getRetiringPrincipal()) == 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
+ ((getRetiringPrincipal() == null) ? 0
: getRetiringPrincipal().hashCode());
return hashCode;
}
@Override
public ListRetirableGrantsRequest clone() {
return (ListRetirableGrantsRequest) super.clone();
}
}