software.amazon.awssdk.services.ec2.model

Class PurchaseCapacityBlockRequest

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.PurchaseCapacityBlockRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PurchaseCapacityBlockRequest.Builder,PurchaseCapacityBlockRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class PurchaseCapacityBlockRequest
extends Ec2Request
implements ToCopyableBuilder<PurchaseCapacityBlockRequest.Builder,PurchaseCapacityBlockRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PurchaseCapacityBlockRequest.Builder

Method Summary

Modifier and Type	Method and Description
static PurchaseCapacityBlockRequest.Builder	builder()
String	capacityBlockOfferingId() The ID of the Capacity Block offering.
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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTagSpecifications() For responses, this returns true if the service returned a value for the TagSpecifications property.
CapacityReservationInstancePlatform	instancePlatform() The type of operating system for which to reserve capacity.
String	instancePlatformAsString() The type of operating system for which to reserve capacity.
List<SdkField<?>>	sdkFields()
static Class<? extends PurchaseCapacityBlockRequest.Builder>	serializableBuilderClass()
List<TagSpecification>	tagSpecifications() The tags to apply to the Capacity Block during launch.
PurchaseCapacityBlockRequest.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

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 is UnauthorizedOperation.

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 is UnauthorizedOperation.

hasTagSpecifications

public final boolean hasTagSpecifications()

For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tagSpecifications

public final List<TagSpecification> tagSpecifications()

The tags to apply to the Capacity Block during launch.

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 hasTagSpecifications() method.

Returns:

The tags to apply to the Capacity Block during launch.

capacityBlockOfferingId

public final String capacityBlockOfferingId()

The ID of the Capacity Block offering.

Returns:

The ID of the Capacity Block offering.

instancePlatform

public final CapacityReservationInstancePlatform instancePlatform()

The type of operating system for which to reserve capacity.

If the service returns an enum value that is not available in the current SDK version, instancePlatform will return CapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instancePlatformAsString().

Returns:

The type of operating system for which to reserve capacity.

See Also:

CapacityReservationInstancePlatform

instancePlatformAsString

public final String instancePlatformAsString()

The type of operating system for which to reserve capacity.

If the service returns an enum value that is not available in the current SDK version, instancePlatform will return CapacityReservationInstancePlatform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instancePlatformAsString().

Returns:

The type of operating system for which to reserve capacity.

See Also:

CapacityReservationInstancePlatform

toBuilder

public PurchaseCapacityBlockRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PurchaseCapacityBlockRequest.Builder,PurchaseCapacityBlockRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static PurchaseCapacityBlockRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PurchaseCapacityBlockRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo