com.amazonaws.services.ec2.model.DescribeElasticGpusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 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.DescribeElasticGpusRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeElasticGpusRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The Elastic Graphics accelerator IDs.
*
*/
private com.amazonaws.internal.SdkInternalList elasticGpuIds;
/**
*
* The filters.
*
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call
* with the returned NextToken
value. This value can be between 5 and 1000.
*
*/
private Integer maxResults;
/**
*
* The token to request the next page of results.
*
*/
private String nextToken;
/**
*
* The Elastic Graphics accelerator IDs.
*
*
* @return The Elastic Graphics accelerator IDs.
*/
public java.util.List getElasticGpuIds() {
if (elasticGpuIds == null) {
elasticGpuIds = new com.amazonaws.internal.SdkInternalList();
}
return elasticGpuIds;
}
/**
*
* The Elastic Graphics accelerator IDs.
*
*
* @param elasticGpuIds
* The Elastic Graphics accelerator IDs.
*/
public void setElasticGpuIds(java.util.Collection elasticGpuIds) {
if (elasticGpuIds == null) {
this.elasticGpuIds = null;
return;
}
this.elasticGpuIds = new com.amazonaws.internal.SdkInternalList(elasticGpuIds);
}
/**
*
* The Elastic Graphics accelerator IDs.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setElasticGpuIds(java.util.Collection)} or {@link #withElasticGpuIds(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param elasticGpuIds
* The Elastic Graphics accelerator IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withElasticGpuIds(String... elasticGpuIds) {
if (this.elasticGpuIds == null) {
setElasticGpuIds(new com.amazonaws.internal.SdkInternalList(elasticGpuIds.length));
}
for (String ele : elasticGpuIds) {
this.elasticGpuIds.add(ele);
}
return this;
}
/**
*
* The Elastic Graphics accelerator IDs.
*
*
* @param elasticGpuIds
* The Elastic Graphics accelerator IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withElasticGpuIds(java.util.Collection elasticGpuIds) {
setElasticGpuIds(elasticGpuIds);
return this;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*
*
* @return The filters.
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example,
* eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is
* associated.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example,
* eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*
*
* 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 in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example,
* eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* The filters.
*
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example, eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* availability-zone
- The Availability Zone in which the Elastic Graphics accelerator resides.
*
*
* -
*
* elastic-gpu-health
- The status of the Elastic Graphics accelerator (OK
|
* IMPAIRED
).
*
*
* -
*
* elastic-gpu-state
- The state of the Elastic Graphics accelerator (ATTACHED
).
*
*
* -
*
* elastic-gpu-type
- The type of Elastic Graphics accelerator; for example,
* eg1.medium
.
*
*
* -
*
* instance-id
- The ID of the instance to which the Elastic Graphics accelerator is associated.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withFilters(java.util.Collection filters) {
setFilters(filters);
return this;
}
/**
*
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call
* with the returned NextToken
value. This value can be between 5 and 1000.
*
*
* @param maxResults
* The maximum number of results to return in a single call. To retrieve the remaining results, make another
* call with the returned NextToken
value. This value can be between 5 and 1000.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call
* with the returned NextToken
value. This value can be between 5 and 1000.
*
*
* @return The maximum number of results to return in a single call. To retrieve the remaining results, make another
* call with the returned NextToken
value. This value can be between 5 and 1000.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in a single call. To retrieve the remaining results, make another call
* with the returned NextToken
value. This value can be between 5 and 1000.
*
*
* @param maxResults
* The maximum number of results to return in a single call. To retrieve the remaining results, make another
* call with the returned NextToken
value. This value can be between 5 and 1000.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token to request the next page of results.
*
*
* @param nextToken
* The token to request the next page of results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token to request the next page of results.
*
*
* @return The token to request the next page of results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token to request the next page of results.
*
*
* @param nextToken
* The token to request the next page of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeElasticGpusRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* 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 DescribeElasticGpusRequestMarshaller().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 (getElasticGpuIds() != null)
sb.append("ElasticGpuIds: ").append(getElasticGpuIds()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeElasticGpusRequest == false)
return false;
DescribeElasticGpusRequest other = (DescribeElasticGpusRequest) obj;
if (other.getElasticGpuIds() == null ^ this.getElasticGpuIds() == null)
return false;
if (other.getElasticGpuIds() != null && other.getElasticGpuIds().equals(this.getElasticGpuIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getElasticGpuIds() == null) ? 0 : getElasticGpuIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public DescribeElasticGpusRequest clone() {
return (DescribeElasticGpusRequest) super.clone();
}
}