Class DescribeCapacityBlockOfferingsRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeCapacityBlockOfferingsRequest.Builder,DescribeCapacityBlockOfferingsRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal BooleanInclude all Availability Zones and Local Zones, regardless of your opt-in status.builder()final IntegerThe reservation duration for the Capacity Block, in hours.final BooleandryRun()Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final InstantThe latest end date for the Capacity Block offering.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the InstanceTypePreferences property.final IntegerThe number of instances for which to reserve capacity.final StringThe type of instance for which the Capacity Block offering reserves capacity.List of instance type preferences for the Capacity Block offering search.final IntegerThe maximum number of items to return for this request.final StringThe token to use to retrieve the next page of results.static Class<? extends DescribeCapacityBlockOfferingsRequest.Builder> final InstantThe earliest start date for the Capacity Block offering.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final IntegerThe number of EC2 UltraServers in the offerings.final StringThe EC2 UltraServer type of the Capacity Block offerings.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
instanceType
The type of instance for which the Capacity Block offering reserves capacity.
- Returns:
- The type of instance for which the Capacity Block offering reserves capacity.
-
instanceCount
The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
- Returns:
- The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks.
-
startDateRange
The earliest start date for the Capacity Block offering.
- Returns:
- The earliest start date for the Capacity Block offering.
-
endDateRange
The latest end date for the Capacity Block offering.
- Returns:
- The latest end date for the Capacity Block offering.
-
capacityDurationHours
The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
- Returns:
- The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days.
-
nextToken
The token to use to retrieve the next page of results.
- Returns:
- The token to use to retrieve the next page of results.
-
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.
- Returns:
- 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.
-
ultraserverType
The EC2 UltraServer type of the Capacity Block offerings.
- Returns:
- The EC2 UltraServer type of the Capacity Block offerings.
-
ultraserverCount
The number of EC2 UltraServers in the offerings.
- Returns:
- The number of EC2 UltraServers in the offerings.
-
allAvailabilityZones
Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.
- Returns:
- Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the Amazon Web Services Region and Local Zones you are opted into.
-
hasInstanceTypePreferences
public final boolean hasInstanceTypePreferences()For responses, this returns true if the service returned a value for the InstanceTypePreferences 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. -
instanceTypePreferences
List of instance type preferences for the Capacity Block offering search. Accepts one or more instance type names. Either this or the legacy
InstanceTypeparameter is required.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
hasInstanceTypePreferences()method.- Returns:
- List of instance type preferences for the Capacity Block offering search. Accepts one or more instance
type names. Either this or the legacy
InstanceTypeparameter is required.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeCapacityBlockOfferingsRequest.Builder,DescribeCapacityBlockOfferingsRequest> - Specified by:
toBuilderin classEc2Request- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeCapacityBlockOfferingsRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- Parameters:
fieldName- The name of the member to be retrieved.clazz- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-