Class DescribeBundleTasksRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeBundleTasksRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeBundleTasksRequest.Builder,DescribeBundleTasksRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBundleTasksRequest extends Ec2Request implements ToCopyableBuilder<DescribeBundleTasksRequest.Builder,DescribeBundleTasksRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeBundleTasksRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeBundleTasksRequest.Builder
builder()
List<String>
bundleIds()
The bundle task IDs.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasBundleIds()
For responses, this returns true if the service returned a value for the BundleIds property.boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends DescribeBundleTasksRequest.Builder>
serializableBuilderClass()
DescribeBundleTasksRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasBundleIds
public final boolean hasBundleIds()
For responses, this returns true if the service returned a value for the BundleIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
bundleIds
public final List<String> bundleIds()
The bundle task IDs.
Default: Describes all your bundle tasks.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasBundleIds()
method.- Returns:
- The bundle task IDs.
Default: Describes all your bundle tasks.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
filters
public final List<Filter> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasFilters()
method.- Returns:
- 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.
-
-
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
toBuilder
public DescribeBundleTasksRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeBundleTasksRequest.Builder,DescribeBundleTasksRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeBundleTasksRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeBundleTasksRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-