com.amazonaws.services.ec2.model.DescribeBundleTasksRequest 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.DescribeBundleTasksRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The bundle task IDs.
*
*
* Default: Describes all your bundle tasks.
*
*/
private com.amazonaws.internal.SdkInternalList bundleIds;
/**
*
* The filters.
*
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The bundle task IDs.
*
*
* Default: Describes all your bundle tasks.
*
*
* @return The bundle task IDs.
*
* Default: Describes all your bundle tasks.
*/
public java.util.List getBundleIds() {
if (bundleIds == null) {
bundleIds = new com.amazonaws.internal.SdkInternalList();
}
return bundleIds;
}
/**
*
* The bundle task IDs.
*
*
* Default: Describes all your bundle tasks.
*
*
* @param bundleIds
* The bundle task IDs.
*
* Default: Describes all your bundle tasks.
*/
public void setBundleIds(java.util.Collection bundleIds) {
if (bundleIds == null) {
this.bundleIds = null;
return;
}
this.bundleIds = new com.amazonaws.internal.SdkInternalList(bundleIds);
}
/**
*
* The bundle task IDs.
*
*
* Default: Describes all your bundle tasks.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setBundleIds(java.util.Collection)} or {@link #withBundleIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param bundleIds
* The bundle task IDs.
*
* Default: Describes all your bundle tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBundleTasksRequest withBundleIds(String... bundleIds) {
if (this.bundleIds == null) {
setBundleIds(new com.amazonaws.internal.SdkInternalList(bundleIds.length));
}
for (String ele : bundleIds) {
this.bundleIds.add(ele);
}
return this;
}
/**
*
* The bundle task IDs.
*
*
* Default: Describes all your bundle tasks.
*
*
* @param bundleIds
* The bundle task IDs.
*
* Default: Describes all your bundle tasks.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBundleTasksRequest withBundleIds(java.util.Collection bundleIds) {
setBundleIds(bundleIds);
return this;
}
/**
*
* The filters.
*
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*
*
* @return The filters.
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* The filters.
*
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(filters);
}
/**
*
* The filters.
*
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*
*
* 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.
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBundleTasksRequest 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.
*
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
*
*
* @param filters
* The filters.
*
* -
*
* bundle-id - The ID of the bundle task.
*
*
* -
*
* error-code - If the task failed, the error code returned.
*
*
* -
*
* error-message - If the task failed, the error message returned.
*
*
* -
*
* instance-id - The ID of the instance.
*
*
* -
*
* progress - The level of task completion, as a percentage (for example, 20%).
*
*
* -
*
* s3-bucket - The Amazon S3 bucket to store the AMI.
*
*
* -
*
* s3-prefix - The beginning of the AMI name.
*
*
* -
*
* start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
*
*
* -
*
* state - The state of the task (pending | waiting-for-shutdown |
* bundling | storing | cancelling | complete |
* failed).
*
*
* -
*
* update-time - The time of the most recent update for the task.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeBundleTasksRequest withFilters(java.util.Collection filters) {
setFilters(filters);
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 DescribeBundleTasksRequestMarshaller().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 (getBundleIds() != null)
sb.append("BundleIds: ").append(getBundleIds()).append(",");
if (getFilters() != null)
sb.append("Filters: ").append(getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeBundleTasksRequest == false)
return false;
DescribeBundleTasksRequest other = (DescribeBundleTasksRequest) obj;
if (other.getBundleIds() == null ^ this.getBundleIds() == null)
return false;
if (other.getBundleIds() != null && other.getBundleIds().equals(this.getBundleIds()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBundleIds() == null) ? 0 : getBundleIds().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeBundleTasksRequest clone() {
return (DescribeBundleTasksRequest) super.clone();
}
}