com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 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.identitymanagement.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* Container for the parameters to the {@link com.amazonaws.services.identitymanagement.AmazonIdentityManagement#listVirtualMFADevices(ListVirtualMFADevicesRequest) ListVirtualMFADevices operation}.
*
* Lists the virtual MFA devices under the AWS account by assignment
* status. If you do not specify an assignment status, the action returns
* a list of all virtual MFA devices. Assignment status can be
* Assigned ,
* Unassigned , or Any .
*
*
* You can paginate the results using the MaxItems and
* Marker parameters.
*
*
* @see com.amazonaws.services.identitymanagement.AmazonIdentityManagement#listVirtualMFADevices(ListVirtualMFADevicesRequest)
*/
public class ListVirtualMFADevicesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*/
private String assignmentStatus;
/**
* Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*/
private String marker;
/**
* Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*
* Constraints:
* Range: 1 - 1000
*/
private Integer maxItems;
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*
* @return The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* @see AssignmentStatusType
*/
public String getAssignmentStatus() {
return assignmentStatus;
}
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*
* @param assignmentStatus The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* @see AssignmentStatusType
*/
public void setAssignmentStatus(String assignmentStatus) {
this.assignmentStatus = assignmentStatus;
}
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*
* @param assignmentStatus The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AssignmentStatusType
*/
public ListVirtualMFADevicesRequest withAssignmentStatus(String assignmentStatus) {
this.assignmentStatus = assignmentStatus;
return this;
}
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*
* @param assignmentStatus The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* @see AssignmentStatusType
*/
public void setAssignmentStatus(AssignmentStatusType assignmentStatus) {
this.assignmentStatus = assignmentStatus.toString();
}
/**
* The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Allowed Values: Assigned, Unassigned, Any
*
* @param assignmentStatus The status (unassigned or assigned) of the devices to list. If you do
* not specify an AssignmentStatus, the action defaults to
* Any which lists both assigned and unassigned virtual MFA
* devices.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*
* @see AssignmentStatusType
*/
public ListVirtualMFADevicesRequest withAssignmentStatus(AssignmentStatusType assignmentStatus) {
this.assignmentStatus = assignmentStatus.toString();
return this;
}
/**
* Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @return Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*/
public String getMarker() {
return marker;
}
/**
* Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @param marker Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in 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've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Length: 1 - 320
* Pattern: [\u0020-\u00FF]*
*
* @param marker Use this parameter only when paginating results, and only in a
* subsequent request after you've received a response where the results
* are truncated. Set it to the value of the Marker element
* in the response you just received.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListVirtualMFADevicesRequest withMarker(String marker) {
this.marker = marker;
return this;
}
/**
* Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*
* Constraints:
* Range: 1 - 1000
*
* @return Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*/
public Integer getMaxItems() {
return maxItems;
}
/**
* Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*
* Constraints:
* Range: 1 - 1000
*
* @param maxItems Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*/
public void setMaxItems(Integer maxItems) {
this.maxItems = maxItems;
}
/**
* Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*
* Returns a reference to this object so that method calls can be chained together.
*
* Constraints:
* Range: 1 - 1000
*
* @param maxItems Use this parameter only when paginating results to indicate the
* maximum number of user names you want in the response. If there are
* additional user names beyond the maximum you specify, the
* IsTruncated response element is true. This
* parameter is optional. If you do not include it, it defaults to 100.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public ListVirtualMFADevicesRequest withMaxItems(Integer maxItems) {
this.maxItems = maxItems;
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 (getAssignmentStatus() != null) sb.append("AssignmentStatus: " + getAssignmentStatus() + ",");
if (getMarker() != null) sb.append("Marker: " + getMarker() + ",");
if (getMaxItems() != null) sb.append("MaxItems: " + getMaxItems() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAssignmentStatus() == null) ? 0 : getAssignmentStatus().hashCode());
hashCode = prime * hashCode + ((getMarker() == null) ? 0 : getMarker().hashCode());
hashCode = prime * hashCode + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof ListVirtualMFADevicesRequest == false) return false;
ListVirtualMFADevicesRequest other = (ListVirtualMFADevicesRequest)obj;
if (other.getAssignmentStatus() == null ^ this.getAssignmentStatus() == null) return false;
if (other.getAssignmentStatus() != null && other.getAssignmentStatus().equals(this.getAssignmentStatus()) == 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.getMaxItems() == null ^ this.getMaxItems() == null) return false;
if (other.getMaxItems() != null && other.getMaxItems().equals(this.getMaxItems()) == false) return false;
return true;
}
}