Class DescribeScheduledInstanceAvailabilityRequest
- 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.DescribeScheduledInstanceAvailabilityRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeScheduledInstanceAvailabilityRequest.Builder,DescribeScheduledInstanceAvailabilityRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeScheduledInstanceAvailabilityRequest extends Ec2Request implements ToCopyableBuilder<DescribeScheduledInstanceAvailabilityRequest.Builder,DescribeScheduledInstanceAvailabilityRequest>
Contains the parameters for DescribeScheduledInstanceAvailability.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeScheduledInstanceAvailabilityRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeScheduledInstanceAvailabilityRequest.Builder
builder()
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.SlotDateTimeRangeRequest
firstSlotStartTimeRange()
The time period for the first schedule to start.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
Integer
maxResults()
The maximum number of results to return in a single call.Integer
maxSlotDurationInHours()
The maximum available duration, in hours.Integer
minSlotDurationInHours()
The minimum available duration, in hours.String
nextToken()
The token for the next set of results.ScheduledInstanceRecurrenceRequest
recurrence()
The schedule recurrence.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeScheduledInstanceAvailabilityRequest.Builder>
serializableBuilderClass()
DescribeScheduledInstanceAvailabilityRequest.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 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
.
-
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.
-
availability-zone
- The Availability Zone (for example,us-west-2a
). -
instance-type
- The instance type (for example,c4.large
). -
platform
- The platform (Linux/UNIX
orWindows
).
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.
-
availability-zone
- The Availability Zone (for example,us-west-2a
). -
instance-type
- The instance type (for example,c4.large
). -
platform
- The platform (Linux/UNIX
orWindows
).
-
-
-
firstSlotStartTimeRange
public final SlotDateTimeRangeRequest firstSlotStartTimeRange()
The time period for the first schedule to start.
- Returns:
- The time period for the first schedule to start.
-
maxResults
public final Integer maxResults()
The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned
NextToken
value.- Returns:
- The maximum number of results to return in a single call. This value can be between 5 and 300. The
default value is 300. To retrieve the remaining results, make another call with the returned
NextToken
value.
-
maxSlotDurationInHours
public final Integer maxSlotDurationInHours()
The maximum available duration, in hours. This value must be greater than
MinSlotDurationInHours
and less than 1,720.- Returns:
- The maximum available duration, in hours. This value must be greater than
MinSlotDurationInHours
and less than 1,720.
-
minSlotDurationInHours
public final Integer minSlotDurationInHours()
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
- Returns:
- The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
-
nextToken
public final String nextToken()
The token for the next set of results.
- Returns:
- The token for the next set of results.
-
recurrence
public final ScheduledInstanceRecurrenceRequest recurrence()
The schedule recurrence.
- Returns:
- The schedule recurrence.
-
toBuilder
public DescribeScheduledInstanceAvailabilityRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeScheduledInstanceAvailabilityRequest.Builder,DescribeScheduledInstanceAvailabilityRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeScheduledInstanceAvailabilityRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeScheduledInstanceAvailabilityRequest.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
-
-