/* * Copyright 2018-2023 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.ec2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeInstanceStatusRequestMarshaller; /** * */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest { /** *

* The filters. *

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte * is used for internal purposes and should be ignored. The low byte is set based on the state represented. The * valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running | * shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is reachability ( * passed | failed | initializing | insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*

*/ private com.amazonaws.internal.SdkInternalList filters; /** *

* The instance IDs. *

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. *

*/ private com.amazonaws.internal.SdkInternalList instanceIds; /** *

* The maximum number of items to return for this request. To get the next page of items, make another request with * the token returned in the output. For more information, see Pagination. *

* You cannot specify this parameter and the instance IDs parameter in the same request. *

*/ private Integer maxResults; /** *

* The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *

*/ private String nextToken; /** *

* When true, includes the health status for all instances. When false, includes the * health status for running instances only. *

* Default: false *

*/ private Boolean includeAllInstances; /** *

* The filters. *

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte * is used for internal purposes and should be ignored. The low byte is set based on the state represented. The * valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running | * shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is reachability ( * passed | failed | initializing | insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*

* * @return The filters.

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The * high byte is used for internal purposes and should be ignored. The low byte is set based on the state * represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 * (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running * | shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired * | initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | * impaired | initializing | insufficient-data | * not-applicable). *
*

getFilters() { if (filters == null) { filters = new com.amazonaws.internal.SdkInternalList(); } return filters; } /** *

* The filters. *

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte * is used for internal purposes and should be ignored. The low byte is set based on the state represented. The * valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running | * shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is reachability ( * passed | failed | initializing | insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*

* * @param filters * The filters.

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high * byte is used for internal purposes and should be ignored. The low byte is set based on the state * represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 * (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running * | shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired * | initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | * impaired | initializing | insufficient-data | * not-applicable). *
*

filters) { if (filters == null) { this.filters = null; return; } this.filters = new com.amazonaws.internal.SdkInternalList(filters); } /** *

* The filters. *

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte * is used for internal purposes and should be ignored. The low byte is set based on the state represented. The * valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running | * shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is reachability ( * passed | failed | initializing | insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setFilters(java.util.Collection)} or {@link #withFilters(java.util.Collection)} if you want to override * the existing values. *

* * @param filters * The filters.

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high * byte is used for internal purposes and should be ignored. The low byte is set based on the state * represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 * (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running * | shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired * | initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | * impaired | initializing | insufficient-data | * not-applicable). *
*

(filters.length)); } for (Filter ele : filters) { this.filters.add(ele); } return this; } /** *

* The filters. *

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte * is used for internal purposes and should be ignored. The low byte is set based on the state represented. The * valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running | * shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is reachability ( * passed | failed | initializing | insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | impaired | * initializing | insufficient-data | not-applicable). *
*

* * @param filters * The filters.

*
* availability-zone - The Availability Zone of the instance. *
*
*
* event.code - The code for the scheduled event (instance-reboot | * system-reboot | system-maintenance | instance-retirement | * instance-stop). *
*
*
* event.description - A description of the event. *
*
*
* event.instance-event-id - The ID of the event whose date and time you are modifying. *
*
*
* event.not-after - The latest end time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before - The earliest start time for the scheduled event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* event.not-before-deadline - The deadline for starting the event (for example, * 2014-09-15T17:15:20.000Z). *
*
*
* instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high * byte is used for internal purposes and should be ignored. The low byte is set based on the state * represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 * (stopping), and 80 (stopped). *
*
*
* instance-state-name - The state of the instance (pending | running * | shutting-down | terminated | stopping | stopped). *
*
*
* instance-status.reachability - Filters on instance status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* instance-status.status - The status of the instance (ok | impaired * | initializing | insufficient-data | not-applicable). *
*
*
* system-status.reachability - Filters on system status where the name is * reachability (passed | failed | initializing | * insufficient-data). *
*
*
* system-status.status - The system status of the instance (ok | * impaired | initializing | insufficient-data | * not-applicable). *
*

filters) { setFilters(filters); return this; } /** *

* The instance IDs. *

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. *

* * @return The instance IDs.

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. */ public java.util.List getInstanceIds() { if (instanceIds == null) { instanceIds = new com.amazonaws.internal.SdkInternalList(); } return instanceIds; } /** *

* The instance IDs. *

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. *

* * @param instanceIds * The instance IDs.

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. */ public void setInstanceIds(java.util.Collection instanceIds) { if (instanceIds == null) { this.instanceIds = null; return; } this.instanceIds = new com.amazonaws.internal.SdkInternalList(instanceIds); } /** *

* The instance IDs. *

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. *

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setInstanceIds(java.util.Collection)} or {@link #withInstanceIds(java.util.Collection)} if you want to * override the existing values. *

* * @param instanceIds * The instance IDs.

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeInstanceStatusRequest withInstanceIds(String... instanceIds) { if (this.instanceIds == null) { setInstanceIds(new com.amazonaws.internal.SdkInternalList(instanceIds.length)); } for (String ele : instanceIds) { this.instanceIds.add(ele); } return this; } /** *

* The instance IDs. *

* Default: Describes all your instances. *

* Constraints: Maximum 100 explicitly specified instance IDs. *

* * @param instanceIds * The instance IDs.

* Default: Describes all your instances. *

* The maximum number of items to return for this request. To get the next page of items, make another request with * the token returned in the output. For more information, see Pagination. *

* You cannot specify this parameter and the instance IDs parameter in the same request. *

* * @param maxResults * The maximum number of items to return for this request. To get the next page of items, make another * request with the token returned in the output. For more information, see Pagination.

* You cannot specify this parameter and the instance IDs parameter in the same request. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of items to return for this request. To get the next page of items, make another request with * the token returned in the output. For more information, see Pagination. *

* You cannot specify this parameter and the instance IDs parameter in the same request. *

* * @return The maximum number of items to return for this request. To get the next page of items, make another * request with the token returned in the output. For more information, see Pagination.

* You cannot specify this parameter and the instance IDs parameter in the same request. */ public Integer getMaxResults() { return this.maxResults; } /** *

* The maximum number of items to return for this request. To get the next page of items, make another request with * the token returned in the output. For more information, see Pagination. *

* You cannot specify this parameter and the instance IDs parameter in the same request. *

* You cannot specify this parameter and the instance IDs parameter in the same request. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeInstanceStatusRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *

* The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *

* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. */ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *

* * @return The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. */ public String getNextToken() { return this.nextToken; } /** *

* The token returned from a previous paginated request. Pagination continues from the end of the items returned by * the previous request. *

* * @param nextToken * The token returned from a previous paginated request. Pagination continues from the end of the items * returned by the previous request. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeInstanceStatusRequest withNextToken(String nextToken) { setNextToken(nextToken); return this; } /** *

* When true, includes the health status for all instances. When false, includes the * health status for running instances only. *

* Default: false *

* * @param includeAllInstances * When true, includes the health status for all instances. When false, includes * the health status for running instances only.

* Default: false */ public void setIncludeAllInstances(Boolean includeAllInstances) { this.includeAllInstances = includeAllInstances; } /** *

* When true, includes the health status for all instances. When false, includes the * health status for running instances only. *

* Default: false *

* * @return When true, includes the health status for all instances. When false, includes * the health status for running instances only.

* Default: false */ public Boolean getIncludeAllInstances() { return this.includeAllInstances; } /** *

* When true, includes the health status for all instances. When false, includes the * health status for running instances only. *

* Default: false *

* * @param includeAllInstances * When true, includes the health status for all instances. When false, includes * the health status for running instances only.

* Default: false * @return Returns a reference to this object so that method calls can be chained together. */ public DescribeInstanceStatusRequest withIncludeAllInstances(Boolean includeAllInstances) { setIncludeAllInstances(includeAllInstances); return this; } /** *

* When true, includes the health status for all instances. When false, includes the * health status for running instances only. *

* Default: false *

* * @return When true, includes the health status for all instances. When false, includes * the health status for running instances only.

* Default: false */ public Boolean isIncludeAllInstances() { return this.includeAllInstances; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request getDryRunRequest() { Request request = new DescribeInstanceStatusRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * 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 (getFilters() != null) sb.append("Filters: ").append(getFilters()).append(","); if (getInstanceIds() != null) sb.append("InstanceIds: ").append(getInstanceIds()).append(","); if (getMaxResults() != null) sb.append("MaxResults: ").append(getMaxResults()).append(","); if (getNextToken() != null) sb.append("NextToken: ").append(getNextToken()).append(","); if (getIncludeAllInstances() != null) sb.append("IncludeAllInstances: ").append(getIncludeAllInstances()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribeInstanceStatusRequest == false) return false; DescribeInstanceStatusRequest other = (DescribeInstanceStatusRequest) obj; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getInstanceIds() == null ^ this.getInstanceIds() == null) return false; if (other.getInstanceIds() != null && other.getInstanceIds().equals(this.getInstanceIds()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getIncludeAllInstances() == null ^ this.getIncludeAllInstances() == null) return false; if (other.getIncludeAllInstances() != null && other.getIncludeAllInstances().equals(this.getIncludeAllInstances()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getInstanceIds() == null) ? 0 : getInstanceIds().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getIncludeAllInstances() == null) ? 0 : getIncludeAllInstances().hashCode()); return hashCode; } @Override public DescribeInstanceStatusRequest clone() { return (DescribeInstanceStatusRequest) super.clone(); } }